Struct graph_oauth::AuthCodeAuthorizationUrlParameterBuilder

pub struct AuthCodeAuthorizationUrlParameterBuilder { /* private fields */ }

Implementations

impl AuthCodeAuthorizationUrlParameterBuilder

pub fn with_client_id(&mut self, client_id: impl TryInto<Uuid>) -> &mut Self

pub fn with_tenant(&mut self, tenant_id: impl AsRef<str>) -> &mut Self

Convenience method. Same as calling [with_authority(Authority::TenantId(“tenant_id”))]

pub fn with_authority(&mut self, authority: impl Into<Authority>) -> &mut Self

pub fn with_azure_cloud_instance( &mut self, azure_cloud_instance: AzureCloudInstance ) -> &mut Self

pub fn with_extra_query_param( &mut self, query_param: (String, String) ) -> &mut Self

Extends the query parameters of both the default query params and user defined params. Does not overwrite default params.

pub fn with_extra_query_parameters( &mut self, query_parameters: HashMap<String, String> ) -> &mut Self

Extends the query parameters of both the default query params and user defined params. Does not overwrite default params.

pub fn with_extra_header_param<K: Into<HeaderName>, V: Into<HeaderValue>>( &mut self, header_name: K, header_value: V ) -> &mut Self

Extends the header parameters of both the default header params and user defined params. Does not overwrite default params.

pub fn with_extra_header_parameters( &mut self, header_parameters: HeaderMap ) -> &mut Self

Extends the header parameters of both the default header params and user defined params. Does not overwrite default params.

pub fn with_scope<T: ToString, I: IntoIterator<Item = T>>( &mut self, scope: I ) -> &mut Self

impl AuthCodeAuthorizationUrlParameterBuilder

pub fn new( client_id: impl TryInto<Uuid> ) -> AuthCodeAuthorizationUrlParameterBuilder

pub fn with_redirect_uri(&mut self, redirect_uri: Url) -> &mut Self

pub fn with_response_type<I: IntoIterator<Item = ResponseType>>( &mut self, response_type: I ) -> &mut Self

Default is code. Must include code for the authorization code flow. Can also include id_token or token if using the hybrid flow.

pub fn with_response_mode(&mut self, response_mode: ResponseMode) -> &mut Self

Specifies how the identity platform should return the requested token to your app.

Supported values:

• query: Default when requesting an access token. Provides the code as a query string parameter on your redirect URI. The query parameter is not supported when requesting an ID token by using the implicit flow.
• fragment: Default when requesting an ID token by using the implicit flow. Also supported if requesting only a code.
• form_post: Executes a POST containing the code to your redirect URI. Supported when requesting a code.

pub fn with_nonce<T: AsRef<str>>(&mut self, nonce: T) -> &mut Self

A value included in the request, generated by the app, that is included in the resulting id_token as a claim. The app can then verify this value to mitigate token replay attacks. The value is typically a randomized, unique string that can be used to identify the origin of the request.

pub fn with_generated_nonce(&mut self) -> &mut Self

Generates a secure random nonce. Nonce is a value included in the request, generated by the app, that is included in the resulting id_token as a claim. The app can then verify this value to mitigate token replay attacks. The value is typically a randomized, unique string that can be used to identify the origin of the request.

pub fn with_state<T: AsRef<str>>(&mut self, state: T) -> &mut Self

pub fn with_prompt<I: IntoIterator<Item = Prompt>>( &mut self, prompt: I ) -> &mut Self

Indicates the type of user interaction that is required. Valid values are login, none, consent, and select_account.

• prompt=login forces the user to enter their credentials on that request, negating single-sign on.
• prompt=none is the opposite. It ensures that the user isn’t presented with any interactive prompt. If the request can’t be completed silently by using single-sign on, the Microsoft identity platform returns an interaction_required error.
• prompt=consent triggers the OAuth consent dialog after the user signs in, asking the user to grant permissions to the app.
• prompt=select_account interrupts single sign-on providing account selection experience listing all the accounts either in session or any remembered account or an option to choose to use a different account altogether.

pub fn with_domain_hint<T: AsRef<str>>(&mut self, domain_hint: T) -> &mut Self

pub fn with_login_hint<T: AsRef<str>>(&mut self, login_hint: T) -> &mut Self

pub fn with_code_challenge<T: AsRef<str>>( &mut self, code_challenge: T ) -> &mut Self

Used to secure authorization code grants by using Proof Key for Code Exchange (PKCE). Required if code_challenge_method is included.

pub fn with_code_challenge_method<T: AsRef<str>>( &mut self, code_challenge_method: T ) -> &mut Self

The method used to encode the code_verifier for the code_challenge parameter. This SHOULD be S256, but the spec allows the use of plain if the client can’t support SHA256.

If excluded, code_challenge is assumed to be plaintext if code_challenge is included. The Microsoft identity platform supports both plain and S256.

pub fn with_pkce( &mut self, proof_key_for_code_exchange: &ProofKeyCodeExchange ) -> &mut Self

Sets the code_challenge and code_challenge_method using the ProofKeyCodeExchange Callers should keep the ProofKeyCodeExchange and provide it to the credential builder in order to set the client verifier and request an access token.

pub fn build(&self) -> AuthCodeAuthorizationUrlParameters

pub fn url_with_host( &self, azure_cloud_instance: &AzureCloudInstance ) -> IdentityResult<Url>

pub fn url(&self) -> IdentityResult<Url>

pub fn with_auth_code( self, authorization_code: impl AsRef<str> ) -> AuthorizationCodeCredentialBuilder

pub fn with_auth_code_assertion( self, authorization_code: impl AsRef<str> ) -> AuthorizationCodeAssertionCredentialBuilder

Trait Implementations

impl Clone for AuthCodeAuthorizationUrlParameterBuilder

fn clone(&self) -> AuthCodeAuthorizationUrlParameterBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.