AuthRequestParams Class

Reference

Definition

Namespace:: Microsoft.Security.Authentication.OAuth

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Edit

A class that provides methods to create an authorization request parameter object.

Note

This object is used to request authorization code from the server when response_type is code and access_token when response_type is token. The response_type is described in section 3.1.1 of RFC 6749.

public ref class AuthRequestParams sealed

/// [Windows.Foundation.Metadata.Activatable(Microsoft.Security.Authentication.OAuth.IAuthRequestParamsFactory, 65536, "Microsoft.Security.Authentication.OAuth.OAuthContract")]
/// [Windows.Foundation.Metadata.ContractVersion(Microsoft.Security.Authentication.OAuth.OAuthContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class AuthRequestParams final

[Windows.Foundation.Metadata.Activatable(typeof(Microsoft.Security.Authentication.OAuth.IAuthRequestParamsFactory), 65536, "Microsoft.Security.Authentication.OAuth.OAuthContract")]
[Windows.Foundation.Metadata.ContractVersion(typeof(Microsoft.Security.Authentication.OAuth.OAuthContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public sealed class AuthRequestParams

function AuthRequestParams(responseType, clientId, redirectUri)

Public NotInheritable Class AuthRequestParams

Inheritance: Object Platform::Object IInspectable AuthRequestParams

Attributes: ActivatableAttribute ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Constructors

AuthRequestParams(String, String, Uri)	Creates an AuthRequestParams object with responseType, clientId, and redirectUri parameters provided.
AuthRequestParams(String, String)	Creates an AuthRequestParams object with responseType and clientId parameters.

Properties

AdditionalParams	Additional parameters provided in the query string of the request URL.
ClientId	Specifies the required `client_id` parameter of the authorization request described by the section 2.2 of RFC 6749.
CodeChallenge	Used as the Proof Key for Code Exchange (PKCE) `code_challenge` described by the section 4.2 of RFC 7636.
CodeChallengeMethod	Specifies the optional `code_challenge_method` parameter of the authorization request described by the section 4.3 of RFC 7636.
RedirectUri	Specifies the optional `redirect_uri` parameter of the authorization request described by the section 3.1.2 of RFC 6749.
ResponseType	Specifies the required `response_type` parameter of the authorization request described by the section 3.1.1 of RFC 6749.
Scope	Specifies the optional `scope` parameter of the authorization request described by the section 3.3 of RFC 6749.
State	Specifies the recommended `state` parameter of the authorization request described in section 4.1.1 of RFC 6749.

Methods

CreateForAuthorizationCodeRequest(String, Uri)	Helper method to create an authorization code grant request (`code` response type) with the required parameters.
CreateForAuthorizationCodeRequest(String)	Helper method to create an authorization code grant request (`code` response type) with the required parameters.

Applies to

Share via