Class OnBehalfOfAuthenticationProvider

Authentication Provider based on the OnBehalfOf flow

Inheritance
object
OAuthAuthenticationProvider
OnBehalfOfAuthenticationProvider
Inherited Members
Namespace: PnP.Core.Auth
Assembly: PnP.Core.Auth.dll
Syntax
public sealed class OnBehalfOfAuthenticationProvider : OAuthAuthenticationProvider, IAuthenticationProvider
Remarks

You can find further details about the On-Behalf-Of flow here: https://docs.microsoft.com/en-us/azure/active-directory/develop/v2-oauth2-on-behalf-of-flow

Constructors

OnBehalfOfAuthenticationProvider(ILogger<OAuthAuthenticationProvider>, IMsalHttpClientFactory)

Public constructor leveraging DI to initialize the ILogger and IMsalHttpClientFactory interfaces

Declaration
public OnBehalfOfAuthenticationProvider(ILogger<OAuthAuthenticationProvider> logger, IMsalHttpClientFactory msalHttpClientFactory)
Parameters
ILogger<OAuthAuthenticationProvider> logger

The instance of the logger service provided by DI
IMsalHttpClientFactory msalHttpClientFactory

The instance of the Msal Http Client Factory service provided by DI

OnBehalfOfAuthenticationProvider(string, string, PnPCoreAuthenticationOnBehalfOfOptions, Func<string>, bool)

Public constructor for external consumers of the library

Declaration
public OnBehalfOfAuthenticationProvider(string clientId, string tenantId, PnPCoreAuthenticationOnBehalfOfOptions options, Func<string> userTokenProvider, bool useSharedCache = false)
Parameters
string clientId

The Client ID for the Authentication Provider
string tenantId

The Tenant ID for the Authentication Provider
PnPCoreAuthenticationOnBehalfOfOptions options

Options for the authentication provider
Func<string> userTokenProvider

A function providing the consumer user access token to use for the On-Behalf-Of flow
bool useSharedCache

Share the cache between all ClientApplication objects. The cache becomes static. Defaults to false

OnBehalfOfAuthenticationProvider(string, string, StoreName, StoreLocation, string, Func<string>, bool)

Public constructor for external consumers of the library

Declaration
public OnBehalfOfAuthenticationProvider(string clientId, string tenantId, StoreName storeName, StoreLocation storeLocation, string thumbprint, Func<string> userTokenProvider, bool useSharedCache = false)
Parameters
string clientId

The Client ID for the Authentication Provider
string tenantId

The Tenant ID for the Authentication Provider
StoreName storeName

The Store Name to get the X.509 certificate from
StoreLocation storeLocation

The Store Location to get the X.509 certificate from
string thumbprint

The Thumbprint of the X.509 certificate
Func<string> userTokenProvider

A function providing the consumer user access token to use for the On-Behalf-Of flow
bool useSharedCache

Share the cache between all ClientApplication objects. The cache becomes static. Defaults to false

OnBehalfOfAuthenticationProvider(string, string, X509Certificate2, Func<string>, bool)

Public constructor for external consumers of the library

Declaration
public OnBehalfOfAuthenticationProvider(string clientId, string tenantId, X509Certificate2 certificate, Func<string> userTokenProvider, bool useSharedCache = false)
Parameters
string clientId

The Client ID for the Authentication Provider
string tenantId

The Tenant ID for the Authentication Provider
X509Certificate2 certificate

The X.509 certificate to use for authentication
Func<string> userTokenProvider

A function providing the consumer user access token to use for the On-Behalf-Of flow
bool useSharedCache

Share the cache between all ClientApplication objects. The cache becomes static. Defaults to false

OnBehalfOfAuthenticationProvider(string, string, SecureString, Func<string>, bool)

Public constructor for external consumers of the library

Declaration
public OnBehalfOfAuthenticationProvider(string clientId, string tenantId, SecureString clientSecret, Func<string> userTokenProvider, bool useSharedCache = false)
Parameters
string clientId

The Client ID for the Authentication Provider
string tenantId

The Tenant ID for the Authentication Provider
SecureString clientSecret

The Client Secret of the app
Func<string> userTokenProvider

A function providing the consumer user access token to use for the On-Behalf-Of flow
bool useSharedCache

Share the cache between all ClientApplication objects. The cache becomes static. Defaults to false

Properties

Certificate

The X.509 Certificate to use for app authentication

Declaration
public X509Certificate2 Certificate { get; set; }
Property Value
X509Certificate2

ClientSecret

The ClientSecret to authenticate the app with ClientId

Declaration
public SecureString ClientSecret { get; set; }
Property Value
SecureString

UseSharedCache

Share the cache between all ClientApplication objects. The cache becomes static. Defaults to false.

Declaration
public bool UseSharedCache { get; set; }
Property Value
bool

UserTokenProvider

A function providing the consumer user access token to use for the On-Behalf-Of flow

Declaration
public Func<string> UserTokenProvider { get; set; }
Property Value
Func<string>

Methods

AuthenticateRequestAsync(Uri, HttpRequestMessage)

Authenticates the specified request message.

Declaration
public override Task AuthenticateRequestAsync(Uri resource, HttpRequestMessage request)
Parameters
Uri resource

Request uri
HttpRequestMessage request

The HttpRequestMessage to authenticate.
Returns
Task

The task to await.
Overrides

GetAccessTokenAsync(Uri)

Gets an access token for the requested resource

Declaration
public override Task<string> GetAccessTokenAsync(Uri resource)
Parameters
Uri resource

Resource to request an access token for
Returns
Task<string>

An access token
Overrides

GetAccessTokenAsync(Uri, string[])

Gets an access token for the requested resource and scope

Declaration
public override Task<string> GetAccessTokenAsync(Uri resource, string[] scopes)
Parameters
Uri resource

Resource to request an access token for (unused)
string[] scopes

Scopes to request
Returns
Task<string>

An access token
Overrides