Class GetAuthorizationRequestUrlParameterBuilder

Namespace

Microsoft.Identity.Client

Assembly

Microsoft.Identity.Client.dll

NOTE: a few of the methods in AbstractAcquireTokenParameterBuilder (e.g. account) don't make sense here. Do we want to create a further base that contains ALL of the common methods, and then have another one including account, etc that are only used for AcquireToken?

public sealed class GetAuthorizationRequestUrlParameterBuilder : AbstractConfidentialClientAcquireTokenParameterBuilder<GetAuthorizationRequestUrlParameterBuilder>

Inheritance

object

BaseAbstractAcquireTokenParameterBuilder<GetAuthorizationRequestUrlParameterBuilder>

AbstractAcquireTokenParameterBuilder<GetAuthorizationRequestUrlParameterBuilder>

AbstractConfidentialClientAcquireTokenParameterBuilder<GetAuthorizationRequestUrlParameterBuilder>

GetAuthorizationRequestUrlParameterBuilder

Inherited Members

AbstractConfidentialClientAcquireTokenParameterBuilder<GetAuthorizationRequestUrlParameterBuilder>.WithProofOfPossession(PoPAuthenticationConfiguration)

AbstractAcquireTokenParameterBuilder<GetAuthorizationRequestUrlParameterBuilder>.WithClaims(string)

AbstractAcquireTokenParameterBuilder<GetAuthorizationRequestUrlParameterBuilder>.WithExtraQueryParameters(string)

AbstractAcquireTokenParameterBuilder<GetAuthorizationRequestUrlParameterBuilder>.WithTenantId(string)

AbstractAcquireTokenParameterBuilder<GetAuthorizationRequestUrlParameterBuilder>.WithTenantIdFromAuthority(Uri)

AbstractAcquireTokenParameterBuilder<GetAuthorizationRequestUrlParameterBuilder>.WithAdfsAuthority(string, bool)

AbstractAcquireTokenParameterBuilder<GetAuthorizationRequestUrlParameterBuilder>.WithB2CAuthority(string)

BaseAbstractAcquireTokenParameterBuilder<GetAuthorizationRequestUrlParameterBuilder>.WithCorrelationId(Guid)

BaseAbstractAcquireTokenParameterBuilder<GetAuthorizationRequestUrlParameterBuilder>.WithExtraQueryParameters(Dictionary<string, string>)

object.GetType()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Extension Methods

AcquireTokenParameterBuilderExtensions.WithExtraHttpHeaders<T>(AbstractAcquireTokenParameterBuilder<T>, IDictionary<string, string>)

AbstractConfidentialClientAcquireTokenParameterBuilderExtension.OnBeforeTokenRequest<T>(AbstractAcquireTokenParameterBuilder<T>, Func<OnBeforeTokenRequestData, Task>)

AbstractConfidentialClientAcquireTokenParameterBuilderExtension.WithAdditionalCacheParameters<T>(AbstractAcquireTokenParameterBuilder<T>, IEnumerable<string>)

AbstractConfidentialClientAcquireTokenParameterBuilderExtension.WithProofOfPosessionKeyId<T>(AbstractAcquireTokenParameterBuilder<T>, string, string)

Methods

ExecuteAsync()

public Task<Uri> ExecuteAsync()

Returns

Task<Uri>

ExecuteAsync(CancellationToken)

public Task<Uri> ExecuteAsync(CancellationToken cancellationToken)

Parameters

cancellationToken CancellationToken

Returns

Task<Uri>

WithAccount(IAccount)

public GetAuthorizationRequestUrlParameterBuilder WithAccount(IAccount account)

Parameters

account IAccount

Returns

GetAuthorizationRequestUrlParameterBuilder

WithCcsRoutingHint(string, string)

To help with resiliency, the AAD backup authentication system operates as an AAD backup. This will provide the AAD backup authentication system with a routing hint to help improve performance during authentication. The hint created with this api will take precedence over the one created with WithLoginHint(string)

public GetAuthorizationRequestUrlParameterBuilder WithCcsRoutingHint(string userObjectIdentifier, string tenantIdentifier)

Parameters

userObjectIdentifier string

GUID which is unique to the user, parsed from the client_info.

tenantIdentifier string

GUID format of the tenant ID, parsed from the client_info.

Returns

GetAuthorizationRequestUrlParameterBuilder

The builder to chain the .With methods

WithExtraScopesToConsent(IEnumerable<string>)

public GetAuthorizationRequestUrlParameterBuilder WithExtraScopesToConsent(IEnumerable<string> extraScopesToConsent)

Parameters

extraScopesToConsent IEnumerable<string>

Returns

GetAuthorizationRequestUrlParameterBuilder

WithLoginHint(string)

public GetAuthorizationRequestUrlParameterBuilder WithLoginHint(string loginHint)

Parameters

loginHint string

Returns

GetAuthorizationRequestUrlParameterBuilder

WithPkce(out string)

Used to secure authorization code grant via Proof of Key for Code Exchange (PKCE). For more information, see the PKCE RCF: https://tools.ietf.org/html/rfc7636

public GetAuthorizationRequestUrlParameterBuilder WithPkce(out string codeVerifier)

Parameters

codeVerifier string

MSAL.NET will generate it.

Returns

GetAuthorizationRequestUrlParameterBuilder

WithPrompt(Prompt)

Specifies the interactive experience for the user.

public GetAuthorizationRequestUrlParameterBuilder WithPrompt(Prompt prompt)

Parameters

prompt Prompt

Requested interactive experience. The default is SelectAccount

Returns

GetAuthorizationRequestUrlParameterBuilder

The builder to chain the .With methods

WithRedirectUri(string)

Sets the redirect URI to add to the Authorization request URL

public GetAuthorizationRequestUrlParameterBuilder WithRedirectUri(string redirectUri)

Parameters

redirectUri string

Address to return to upon receiving a response from the authority.

Returns

GetAuthorizationRequestUrlParameterBuilder