Class OAuthAuthenticationProvider

Base authentication provider class

Inheritance

object

OAuthAuthenticationProvider

CredentialManagerAuthenticationProvider

DeviceCodeAuthenticationProvider

ExternalAuthenticationProvider

InteractiveAuthenticationProvider

OnBehalfOfAuthenticationProvider

UsernamePasswordAuthenticationProvider

X509CertificateAuthenticationProvider

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: PnP.Core.Auth

Assembly: PnP.Core.Auth.dll

Syntax

public abstract class OAuthAuthenticationProvider : IAuthenticationProvider

Constructors

OAuthAuthenticationProvider(ILogger<OAuthAuthenticationProvider>)

Public constructor for any OAuth Authentication privider

Declaration

public OAuthAuthenticationProvider(ILogger<OAuthAuthenticationProvider> logger)

Parameters

ILogger<OAuthAuthenticationProvider> logger

Properties

ClientId

The ClientId of the application to use for authentication

Declaration

public string ClientId { get; set; }

Property Value

string

ConfigurationName

The Name of the configuration for the Authentication Provider

Declaration

public string ConfigurationName { get; set; }

Property Value

string

TenantId

The Tenant ID for the application, default value is "organizations" for multi-tenant applications

Declaration

public string TenantId { get; set; }

Property Value

string

Methods

AuthenticateRequestAsync(Uri, HttpRequestMessage)

Authenticates the specified request message.

Declaration

public abstract Task AuthenticateRequestAsync(Uri resource, HttpRequestMessage request)

Parameters

Uri resource Request uri

HttpRequestMessage request The HttpRequestMessage to authenticate.

Returns

Task The task to await.

Implements

IAuthenticationProvider.AuthenticateRequestAsync(Uri, HttpRequestMessage)

GetAccessTokenAsync(Uri)

Gets an access token for the requested resource

Declaration

public abstract Task<string> GetAccessTokenAsync(Uri resource)

Parameters

Uri resource Resource to request an access token for

Returns

Task<string> An access token

Implements

IAuthenticationProvider.GetAccessTokenAsync(Uri)

GetAccessTokenAsync(Uri, string[])

Gets an access token for the requested resource and scope

Declaration

public abstract Task<string> GetAccessTokenAsync(Uri resource, string[] scopes)

Parameters

Uri resource Resource to request an access token for

string[] scopes Scopes to request

Returns

Task<string> An access token

Implements

IAuthenticationProvider.GetAccessTokenAsync(Uri, string[])