ConfidentialClientApplication.GetAuthorizationRequestUrlAsync Method

Definition

Overloads

GetAuthorizationRequestUrlAsync(IEnumerable<String>, String, String)

[V2 API] Computes the URL of the authorization request letting the user sign-in and consent to the application accessing specific scopes in the user's name. The URL targets the /authorize endpoint of the authority configured in the application. This override enables you to specify a login hint and extra query parameter.

GetAuthorizationRequestUrlAsync(IEnumerable<String>, String, String, String, IEnumerable<String>, String)

[V2 API] Computes the URL of the authorization request letting the user sign-in and consent to the application accessing specific scopes in the user's name. The URL targets the /authorize endpoint of the authority specified as the authority parameter. This override enables you to specify a redirectUri, login hint extra query parameters, extra scope to consent (which are not for the same resource as the scopes), and an authority.

GetAuthorizationRequestUrlAsync(IEnumerable<String>, String, String)

Warning

This API is now obsolete.

[V2 API] Computes the URL of the authorization request letting the user sign-in and consent to the application accessing specific scopes in the user's name. The URL targets the /authorize endpoint of the authority configured in the application. This override enables you to specify a login hint and extra query parameter.

[System.Obsolete("Use GetAuthorizationRequestUrl instead. See https://aka.ms/msal-net-3-breaking-changes", true)]
public System.Threading.Tasks.Task<Uri> GetAuthorizationRequestUrlAsync (System.Collections.Generic.IEnumerable<string> scopes, string loginHint, string extraQueryParameters);
abstract member GetAuthorizationRequestUrlAsync : seq<string> * string * string -> System.Threading.Tasks.Task<Uri>
override this.GetAuthorizationRequestUrlAsync : seq<string> * string * string -> System.Threading.Tasks.Task<Uri>
Public Function GetAuthorizationRequestUrlAsync (scopes As IEnumerable(Of String), loginHint As String, extraQueryParameters As String) As Task(Of Uri)

Parameters

scopes
IEnumerable<String>

Scopes requested to access a protected API

loginHint
String

Identifier of the user. Generally a UPN. This can be empty

extraQueryParameters
String

This parameter will be appended as is to the query string in the HTTP authentication request to the authority. This is expected to be a string of segments of the form key=value separated by an ampersand character. The parameter can be null.

Returns

URL of the authorize endpoint including the query parameters.

Implements

Attributes

See also

GetAuthorizationRequestUrlAsync(IEnumerable<String>, String, String, String, IEnumerable<String>, String)

Warning

This API is now obsolete.

[V2 API] Computes the URL of the authorization request letting the user sign-in and consent to the application accessing specific scopes in the user's name. The URL targets the /authorize endpoint of the authority specified as the authority parameter. This override enables you to specify a redirectUri, login hint extra query parameters, extra scope to consent (which are not for the same resource as the scopes), and an authority.

[System.Obsolete("Use GetAuthorizationRequestUrl instead. See https://aka.ms/msal-net-3-breaking-changes", true)]
public System.Threading.Tasks.Task<Uri> GetAuthorizationRequestUrlAsync (System.Collections.Generic.IEnumerable<string> scopes, string redirectUri, string loginHint, string extraQueryParameters, System.Collections.Generic.IEnumerable<string> extraScopesToConsent, string authority);
abstract member GetAuthorizationRequestUrlAsync : seq<string> * string * string * string * seq<string> * string -> System.Threading.Tasks.Task<Uri>
override this.GetAuthorizationRequestUrlAsync : seq<string> * string * string * string * seq<string> * string -> System.Threading.Tasks.Task<Uri>
Public Function GetAuthorizationRequestUrlAsync (scopes As IEnumerable(Of String), redirectUri As String, loginHint As String, extraQueryParameters As String, extraScopesToConsent As IEnumerable(Of String), authority As String) As Task(Of Uri)

Parameters

scopes
IEnumerable<String>

Scopes requested to access a protected API (a resource)

redirectUri
String

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

loginHint
String

Identifier of the user. Generally a UPN.

extraQueryParameters
String

This parameter will be appended as is to the query string in the HTTP authentication request to the authority. This is expected to be a string of segments of the form key=value separated by an ampersand character. The parameter can be null.

extraScopesToConsent
IEnumerable<String>

Scopes for additional resources (other than the resource for which scopes are requested), which a developer can request the user to consent to upfront.

authority
String

Specific authority for which the token is requested. Passing a different value than configured does not change the configured value

Returns

URL of the authorize endpoint including the query parameters.

Implements

Attributes

See also

Applies to