Struct ImplicitCredentialBuilder

pub struct ImplicitCredentialBuilder { /* private fields */ }

Implementations

impl ImplicitCredentialBuilder

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 ImplicitCredentialBuilder

pub fn new(client_id: impl AsRef<str>) -> ImplicitCredentialBuilder

pub fn with_redirect_uri<U: IntoUrl>( &mut self, redirect_uri: U, ) -> Result<&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 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.

To have the client generate a nonce for you use with_nonce_generated

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

Generates a secure random nonce. 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(&mut self, prompt: Prompt) -> &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 url(&self) -> IdentityResult<Url>

pub fn build(&self) -> ImplicitCredential

Trait Implementations

impl Clone for ImplicitCredentialBuilder

fn clone(&self) -> ImplicitCredentialBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.