external help file	online version	applicable	schema	title
	https://docs.microsoft.com/powershell/module/sharepoint-pnp/connect-pnponline	SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online	2.0.0	Connect-PnPOnline

Connect-PnPOnline

SYNOPSIS

Connect to a SharePoint site

SYNTAX

Main

Connect-PnPOnline -Url <String>
                  [-ReturnConnection [<SwitchParameter>]]
                  [-Credentials <CredentialPipeBind>]
                  [-CurrentCredentials [<SwitchParameter>]]
                  [-UseAdfs [<SwitchParameter>]]
                  [-UseAdfsCert [<SwitchParameter>]]
                  [-Kerberos [<SwitchParameter>]]
                  [-LoginProviderName <String>]
                  [-MinimalHealthScore <Int>]
                  [-RetryCount <Int>]
                  [-RetryWait <Int>]
                  [-RequestTimeout <Int>]
                  [-AuthenticationMode <ClientAuthenticationMode>]
                  [-CreateDrive [<SwitchParameter>]]
                  [-DriveName <String>]
                  [-Scopes <String[]>]
                  [-TenantAdminUrl <String>]
                  [-SkipTenantAdminCheck [<SwitchParameter>]]
                  [-IgnoreSslErrors [<SwitchParameter>]]
                  [-NoTelemetry [<SwitchParameter>]]

Access Token

Connect-PnPOnline -AccessToken <String>
                  [-ReturnConnection [<SwitchParameter>]]
                  [-Url <String>]
                  [-MinimalHealthScore <Int>]
                  [-RetryCount <Int>]
                  [-RetryWait <Int>]
                  [-RequestTimeout <Int>]
                  [-CreateDrive [<SwitchParameter>]]
                  [-DriveName <String>]
                  [-SkipTenantAdminCheck [<SwitchParameter>]]
                  [-NoTelemetry [<SwitchParameter>]]

PnP Office 365 Management Shell to the Microsoft Graph

Connect-PnPOnline -Graph [<SwitchParameter>]
                  [-LaunchBrowser [<SwitchParameter>]]
                  [-IgnoreSslErrors [<SwitchParameter>]]
                  [-NoTelemetry [<SwitchParameter>]]

Microsoft Graph using Scopes

Connect-PnPOnline -Scopes <String[]>
                  [-IgnoreSslErrors [<SwitchParameter>]]
                  [-NoTelemetry [<SwitchParameter>]]

WebLogin

Connect-PnPOnline -Url <String>
                  -UseWebLogin [<SwitchParameter>]
                  [-ReturnConnection [<SwitchParameter>]]
                  [-MinimalHealthScore <Int>]
                  [-RetryCount <Int>]
                  [-RetryWait <Int>]
                  [-RequestTimeout <Int>]
                  [-CreateDrive [<SwitchParameter>]]
                  [-DriveName <String>]
                  [-Scopes <String[]>]
                  [-TenantAdminUrl <String>]
                  [-SkipTenantAdminCheck [<SwitchParameter>]]
                  [-IgnoreSslErrors [<SwitchParameter>]]
                  [-NoTelemetry [<SwitchParameter>]]

SPO Management Shell Credentials

Connect-PnPOnline -Url <String>
                  -SPOManagementShell [<SwitchParameter>]
                  [-ReturnConnection [<SwitchParameter>]]
                  [-MinimalHealthScore <Int>]
                  [-RetryCount <Int>]
                  [-RetryWait <Int>]
                  [-RequestTimeout <Int>]
                  [-CreateDrive [<SwitchParameter>]]
                  [-DriveName <String>]
                  [-ClearTokenCache [<SwitchParameter>]]
                  [-Scopes <String[]>]
                  [-TenantAdminUrl <String>]
                  [-SkipTenantAdminCheck [<SwitchParameter>]]
                  [-IgnoreSslErrors [<SwitchParameter>]]
                  [-NoTelemetry [<SwitchParameter>]]

PnP O365 Management Shell / DeviceLogin

Connect-PnPOnline -Url <String>
                  -PnPO365ManagementShell [<SwitchParameter>]
                  [-ReturnConnection [<SwitchParameter>]]
                  [-LaunchBrowser [<SwitchParameter>]]
                  [-NoTelemetry [<SwitchParameter>]]

Token

Connect-PnPOnline -Url <String>
                  -AppId <String>
                  -AppSecret <String>
                  [-ReturnConnection [<SwitchParameter>]]
                  [-MinimalHealthScore <Int>]
                  [-RetryCount <Int>]
                  [-RetryWait <Int>]
                  [-RequestTimeout <Int>]
                  [-Realm <String>]
                  [-CreateDrive [<SwitchParameter>]]
                  [-DriveName <String>]
                  [-AzureEnvironment <AzureEnvironment>]
                  [-Scopes <String[]>]
                  [-TenantAdminUrl <String>]
                  [-SkipTenantAdminCheck [<SwitchParameter>]]
                  [-IgnoreSslErrors [<SwitchParameter>]]
                  [-NoTelemetry [<SwitchParameter>]]

Azure Active Directory

Connect-PnPOnline -Url <String>
                  -ClientId <String>
                  -RedirectUri <String>
                  [-ReturnConnection [<SwitchParameter>]]
                  [-MinimalHealthScore <Int>]
                  [-RetryCount <Int>]
                  [-RetryWait <Int>]
                  [-RequestTimeout <Int>]
                  [-CreateDrive [<SwitchParameter>]]
                  [-DriveName <String>]
                  [-ClearTokenCache [<SwitchParameter>]]
                  [-AzureEnvironment <AzureEnvironment>]
                  [-Scopes <String[]>]
                  [-TenantAdminUrl <String>]
                  [-SkipTenantAdminCheck [<SwitchParameter>]]
                  [-IgnoreSslErrors [<SwitchParameter>]]
                  [-NoTelemetry [<SwitchParameter>]]

App-Only with Azure Active Directory

Connect-PnPOnline -Url <String>
                  -ClientId <String>
                  -Tenant <String>
                  [-ReturnConnection [<SwitchParameter>]]
                  [-MinimalHealthScore <Int>]
                  [-RetryCount <Int>]
                  [-RetryWait <Int>]
                  [-RequestTimeout <Int>]
                  [-CreateDrive [<SwitchParameter>]]
                  [-DriveName <String>]
                  [-CertificatePath <String>]
                  [-CertificateBase64Encoded <String>]
                  [-Certificate <X509Certificate2>]
                  [-CertificatePassword <SecureString>]
                  [-AzureEnvironment <AzureEnvironment>]
                  [-Scopes <String[]>]
                  [-TenantAdminUrl <String>]
                  [-SkipTenantAdminCheck [<SwitchParameter>]]
                  [-IgnoreSslErrors [<SwitchParameter>]]
                  [-NoTelemetry [<SwitchParameter>]]

App-Only with Azure Active Directory using X502 certificates

Connect-PnPOnline -Url <String>
                  -ClientId <String>
                  -Tenant <String>
                  [-ReturnConnection [<SwitchParameter>]]
                  [-MinimalHealthScore <Int>]
                  [-RetryCount <Int>]
                  [-RetryWait <Int>]
                  [-RequestTimeout <Int>]
                  [-CreateDrive [<SwitchParameter>]]
                  [-DriveName <String>]
                  [-AzureEnvironment <AzureEnvironment>]
                  [-TenantAdminUrl <String>]
                  [-SkipTenantAdminCheck [<SwitchParameter>]]
                  [-IgnoreSslErrors [<SwitchParameter>]]
                  [-NoTelemetry [<SwitchParameter>]]

Microsoft Graph using Azure Active Directory

Connect-PnPOnline -AppId <String>
                  -AppSecret <String>
                  -AADDomain <String>
                  [-IgnoreSslErrors [<SwitchParameter>]]
                  [-NoTelemetry [<SwitchParameter>]]

High Trust using a X509Certificate2 object.

Connect-PnPOnline -Url <String>
                  -ClientId <String>
                  -HighTrustCertificate <X509Certificate2>
                  [-ReturnConnection [<SwitchParameter>]]
                  [-MinimalHealthScore <Int>]
                  [-RetryCount <Int>]
                  [-RetryWait <Int>]
                  [-RequestTimeout <Int>]
                  [-CreateDrive [<SwitchParameter>]]
                  [-DriveName <String>]
                  [-TenantAdminUrl <String>]
                  [-SkipTenantAdminCheck [<SwitchParameter>]]
                  [-IgnoreSslErrors [<SwitchParameter>]]
                  [-HighTrustCertificateIssuerId <String>]
                  [-UserName <String>]
                  [-NoTelemetry [<SwitchParameter>]]

App-Only with Azure Active Directory using certificate from certificate store by thumbprint

Connect-PnPOnline -Url <String>
                  -ClientId <String>
                  -Tenant <String>
                  -Thumbprint <String>
                  [-ReturnConnection [<SwitchParameter>]]
                  [-MinimalHealthScore <Int>]
                  [-RetryCount <Int>]
                  [-RetryWait <Int>]
                  [-RequestTimeout <Int>]
                  [-CreateDrive [<SwitchParameter>]]
                  [-DriveName <String>]
                  [-AzureEnvironment <AzureEnvironment>]
                  [-TenantAdminUrl <String>]
                  [-SkipTenantAdminCheck [<SwitchParameter>]]
                  [-IgnoreSslErrors [<SwitchParameter>]]
                  [-NoTelemetry [<SwitchParameter>]]

High Trust using a certificate from a PFX file.

Connect-PnPOnline -Url <String>
                  -ClientId <String>
                  -HighTrustCertificatePath <String>
                  -HighTrustCertificatePassword <String>
                  [-ReturnConnection [<SwitchParameter>]]
                  [-MinimalHealthScore <Int>]
                  [-RetryCount <Int>]
                  [-RetryWait <Int>]
                  [-RequestTimeout <Int>]
                  [-CreateDrive [<SwitchParameter>]]
                  [-DriveName <String>]
                  [-TenantAdminUrl <String>]
                  [-SkipTenantAdminCheck [<SwitchParameter>]]
                  [-IgnoreSslErrors [<SwitchParameter>]]
                  [-HighTrustCertificateIssuerId <String>]
                  [-UserName <String>]
                  [-NoTelemetry [<SwitchParameter>]]

App-Only with Azure Active Directory using certificate as PEM strings

Connect-PnPOnline -Url <String>
                  -ClientId <String>
                  -Tenant <String>
                  -PEMCertificate <String>
                  -PEMPrivateKey <String>
                  [-ReturnConnection [<SwitchParameter>]]
                  [-MinimalHealthScore <Int>]
                  [-RetryCount <Int>]
                  [-RetryWait <Int>]
                  [-RequestTimeout <Int>]
                  [-CreateDrive [<SwitchParameter>]]
                  [-DriveName <String>]
                  [-CertificatePassword <SecureString>]
                  [-AzureEnvironment <AzureEnvironment>]
                  [-TenantAdminUrl <String>]
                  [-SkipTenantAdminCheck [<SwitchParameter>]]
                  [-IgnoreSslErrors [<SwitchParameter>]]
                  [-NoTelemetry [<SwitchParameter>]]

DESCRIPTION

If no credentials have been specified, and the CurrentCredentials parameter has not been specified, you will be prompted for credentials.

EXAMPLES

------------------EXAMPLE 1------------------

Connect-PnPOnline -Url https://contoso.sharepoint.com

This will prompt for username and password and creates a context for the other PowerShell commands to use. When a generic credential is added to the Windows Credential Manager with https://contoso.sharepoint.com, PowerShell will not prompt for username and password.

------------------EXAMPLE 2------------------

Connect-PnPOnline -Url https://contoso.sharepoint.com -Credentials (Get-Credential)

This will prompt for username and password and creates a context for the other PowerShell commands to use.

------------------EXAMPLE 3------------------

Connect-PnPOnline -Url http://yourlocalserver -CurrentCredentials

This will use the current user credentials and connects to the server specified by the Url parameter.

------------------EXAMPLE 4------------------

Connect-PnPOnline -Url http://yourlocalserver -Credentials 'O365Creds'

This will use credentials from the Windows Credential Manager, as defined by the label 'O365Creds'.

------------------EXAMPLE 5------------------

Connect-PnPOnline -Url http://yourlocalserver -Credentials (Get-Credential) -UseAdfs

This will prompt for username and password and creates a context using ADFS to authenticate.

------------------EXAMPLE 6------------------

Connect-PnPOnline -Url http://yourlocalserver -UseAdfsCert

This will enable you to select a certificate to create a context using ADFS to authenticate.

------------------EXAMPLE 7------------------

Connect-PnPOnline -Url https://yourserver -Credentials (Get-Credential) -CreateDrive
cd SPO:\\
dir

This will prompt you for credentials and creates a context for the other PowerShell commands to use. It will also create a SPO:\ drive you can use to navigate around the site

------------------EXAMPLE 8------------------

Connect-PnPOnline -Url https://yourserver -Credentials (Get-Credential) -AuthenticationMode FormsAuthentication

This will prompt you for credentials and creates a context for the other PowerShell commands to use. It assumes your server is configured for Forms Based Authentication (FBA)

------------------EXAMPLE 9------------------

Connect-PnPOnline -Url https://contoso.sharepoint.de -AppId 344b8aab-389c-4e4a-8fa1-4c1ae2c0a60d -AppSecret a3f3faf33f3awf3a3sfs3f3ss3f4f4a3fawfas3ffsrrffssfd -AzureEnvironment Germany

This will authenticate you to the German Azure environment using the German Azure endpoints for authentication

------------------EXAMPLE 10------------------

Connect-PnPOnline -Url https://contoso.sharepoint.com -SPOManagementShell

This will authenticate you using the SharePoint Online Management Shell application

------------------EXAMPLE 11------------------

Connect-PnPOnline -Url https://contoso.sharepoint.com -PnPO365ManagementShell

This will authenticate you using the PnP O365 Management Shell Multi-Tenant application. A browser window will have to be opened where you have to enter a code that is shown in your PowerShell window.

------------------EXAMPLE 12------------------

Connect-PnPOnline -Url https://contoso.sharepoint.com -PnPO365ManagementShell -LaunchBrowser

This will authenticate you using the PnP O365 Management Shell Multi-Tenant application. A browser window will automatically open and the code you need to enter will be automatically copied to your clipboard.

------------------EXAMPLE 13------------------

Connect-PnPOnline -Url https://contoso.sharepoint.com -AccessToken $myaccesstoken

This will authenticate you using the provided access token

------------------EXAMPLE 14------------------

Connect-PnPOnline -Scopes "Mail.Read","Files.Read"

Connects to Azure AD and gets and OAuth 2.0 Access Token to consume the Microsoft Graph API including the declared permission scopes. The available permission scopes are defined at the following URL: https://docs.microsoft.com/en-us/graph/permissions-reference

------------------EXAMPLE 15------------------

Connect-PnPOnline -AppId '<id>' -AppSecret '<secret>' -AADDomain 'contoso.onmicrosoft.com'

Connects to the Microsoft Graph API using application permissions via an app's declared permission scopes. See https://github.com/SharePoint/PnP-PowerShell/tree/master/Samples/Graph.ConnectUsingAppPermissions for a sample on how to get started.

------------------EXAMPLE 16------------------

certutil.exe -csp 'Microsoft Enhanced RSA and AES Cryptographic Provider' -v -p 'password' -importpfx -user c:\HighTrust.pfx NoRoot
Connect-PnPOnline -Url https://yourserver -ClientId <id> -HighTrustCertificate (Get-Item Cert:\CurrentUser\My\<thumbprint>)

Connect to an on-premises SharePoint environment using a high trust certificate, stored in the Personal certificate store of the current user.

------------------EXAMPLE 17------------------

Connect-PnPOnline -Url https://contoso.sharepoint.com -ClientId '<id>' -Tenant 'contoso.onmicrosoft.com' -CertificatePath c:\absolute-path\to\pnp.pfx -CertificatePassword <if needed>

Connects to SharePoint using app-only tokens via an app's declared permission scopes. See https://github.com/SharePoint/PnP-PowerShell/tree/master/Samples/SharePoint.ConnectUsingAppPermissions for a sample on how to get started.

------------------EXAMPLE 18------------------

Connect-PnPOnline -ClientId <id> -CertificatePath 'c:\mycertificate.pfx' -CertificatePassword (ConvertTo-SecureString -AsPlainText 'myprivatekeypassword' -Force) -Url https://contoso.sharepoint.com -Tenant 'contoso.onmicrosoft.com'

Connects using an Azure Active Directory registered application using a locally available certificate containing a private key. See https://docs.microsoft.com/en-us/sharepoint/dev/solution-guidance/security-apponly-azuread for a sample on how to get started.

------------------EXAMPLE 19------------------

Connect-PnPOnline -Url https://yourserver -ClientId 763d5e60-b57e-426e-8e87-b7258f7f8188 -HighTrustCertificatePath c:\HighTrust.pfx -HighTrustCertificatePassword 'password' -HighTrustCertificateIssuerId 6b9534d8-c2c1-49d6-9f4b-cd415620bca8

Connect to an on-premises SharePoint environment using a high trust certificate stored in a .PFX file.

------------------EXAMPLE 20------------------

Connect-PnPOnline -Url https://contoso.sharepoint.com -ClientId '<id>' -Tenant 'contoso.onmicrosoft.com' -Thumbprint 34CFAA860E5FB8C44335A38A097C1E41EEA206AA

------------------EXAMPLE 21------------------

Connect-PnPOnline -Url https://contoso.sharepoint.com -ClientId '<id>' -Tenant 'contoso.onmicrosoft.com' -PEMCertificate <PEM string> -PEMPrivateKey <PEM string> -CertificatePassword <if needed>

------------------EXAMPLE 22------------------

Connect-PnPOnline -ClientId <id> -CertificateBase64Encoded 'xxxx' -CertificatePassword (ConvertTo-SecureString -AsPlainText 'myprivatekeypassword' -Force) -Url https://contoso.sharepoint.com -Tenant 'contoso.onmicrosoft.com'

Connects using an Azure Active Directory registered application using a certificate containing a private key encoded in base 64 such as received in an Azure Function when using Azure KeyVault. See https://docs.microsoft.com/en-us/sharepoint/dev/solution-guidance/security-apponly-azuread for a sample on how to get started.

------------------EXAMPLE 23------------------

Connect-PnPOnline -Url https://contoso.sharepoint.com -ClientId '<id>' -Tenant 'contoso.onmicrosoft.com' -Certificate <X509Certificate2>

Connects to SharePoint using app-only auth in combination with a certificate. See https://docs.microsoft.com/en-us/sharepoint/dev/solution-guidance/security-apponly-azuread#using-this-principal-in-your-powershell-script-using-the-pnp-sites-core-library for a sample on how to get started.

------------------EXAMPLE 24------------------

Connect-PnPOnline -ClientId <id> -Certificate $cert -CertificatePassword (ConvertTo-SecureString -AsPlainText 'myprivatekeypassword' -Force) -Url https://contoso.sharepoint.com -Tenant 'contoso.onmicrosoft.com'

Connects using an Azure Active Directory registered application using a certificate instance containing a private key. See https://docs.microsoft.com/en-us/sharepoint/dev/solution-guidance/security-apponly-azuread for a sample on how to get started.

------------------EXAMPLE 25------------------

Connect-PnPOnline -Url https://contoso.sharepoint.com -ClientId '<id>' -Tenant 'contoso.onmicrosoft.com' -Thumbprint 34CFAA860E5FB8C44335A38A097C1E41EEA206AA -TenantAdminUrl $tenantAdminUrl

Connects to SharePoint using app-only tokens via an app's declared permission scopes. Pass the TenantAdminUrl parameter to perform admin activities like adding Site Collection administrators etc. See https://github.com/SharePoint/PnP-PowerShell/tree/master/Samples/SharePoint.ConnectUsingAppPermissions for a sample on how to get started.

PARAMETERS

-AADDomain

The AAD where the O365 app is registered. Eg.: contoso.com, or contoso.onmicrosoft.com.

Only applicable to: SharePoint Online

Type: String
Parameter Sets: Microsoft Graph using Azure Active Directory

Required: True
Position: Named
Accept pipeline input: False

-AccessToken

Connect with an existing Access Token

Only applicable to: SharePoint Online

Type: String
Parameter Sets: Access Token

Required: True
Position: Named
Accept pipeline input: False

-AppId

The Application Client ID to use.

Type: String
Parameter Sets: Token, Microsoft Graph using Azure Active Directory

Required: True
Position: Named
Accept pipeline input: False

-AppSecret

The Application Client Secret to use.

Type: String
Parameter Sets: Token, Microsoft Graph using Azure Active Directory

Required: True
Position: Named
Accept pipeline input: False

-AuthenticationMode

Specify to use for instance use forms based authentication (FBA)

Type: ClientAuthenticationMode
Parameter Sets: Main

Required: False
Position: Named
Accept pipeline input: False

-AzureEnvironment

The Azure environment to use for authentication, the defaults to 'Production' which is the main Azure environment.

Only applicable to: SharePoint Online

Type: AzureEnvironment
Parameter Sets: Azure Active Directory, App-Only with Azure Active Directory, App-Only with Azure Active Directory using certificate as PEM strings, App-Only with Azure Active Directory using certificate from certificate store by thumbprint, App-Only with Azure Active Directory using X502 certificates, Token

Required: False
Position: Named
Accept pipeline input: False

-Certificate

X509Certificate2 reference containing the private key to authenticate the requests to SharePoint Online

Only applicable to: SharePoint Online

Type: X509Certificate2
Parameter Sets: App-Only with Azure Active Directory

Required: False
Position: Named
Accept pipeline input: False

-CertificateBase64Encoded

Base64 Encoded X509Certificate2 certificate containing the private key to authenticate the requests to SharePoint Online such as retrieved in Azure Functions from Azure KeyVault

Only applicable to: SharePoint Online

Type: String
Parameter Sets: App-Only with Azure Active Directory

Required: False
Position: Named
Accept pipeline input: False

-CertificatePassword

Password to the certificate (*.pfx)

Only applicable to: SharePoint Online

Type: SecureString
Parameter Sets: App-Only with Azure Active Directory, App-Only with Azure Active Directory using certificate as PEM strings

Required: False
Position: Named
Accept pipeline input: False

-CertificatePath

Path to the certificate containing the private key (*.pfx)

Only applicable to: SharePoint Online

Type: String
Parameter Sets: App-Only with Azure Active Directory

Required: False
Position: Named
Accept pipeline input: False

-ClearTokenCache

Clears the token cache.

Only applicable to: SharePoint Online

Type: SwitchParameter
Parameter Sets: Azure Active Directory, SPO Management Shell Credentials

Required: False
Position: Named
Accept pipeline input: False

-ClientId

The Client ID of the Azure AD Application

Type: String
Parameter Sets: Azure Active Directory, App-Only with Azure Active Directory, App-Only with Azure Active Directory using certificate as PEM strings, App-Only with Azure Active Directory using certificate from certificate store by thumbprint, App-Only with Azure Active Directory using X502 certificates

Required: True
Position: Named
Accept pipeline input: False

-CreateDrive

If you want to create a PSDrive connected to the URL

Type: SwitchParameter
Parameter Sets: Main, Token, WebLogin, Azure Active Directory, App-Only with Azure Active Directory, App-Only with Azure Active Directory using certificate as PEM strings, App-Only with Azure Active Directory using certificate from certificate store by thumbprint, App-Only with Azure Active Directory using X502 certificates, SPO Management Shell Credentials, Access Token

Required: False
Position: Named
Accept pipeline input: False

-Credentials

Credentials of the user to connect with. Either specify a PSCredential object or a string. In case of a string value a lookup will be done to the Generic Credentials section of the Windows Credentials in the Windows Credential Manager for the correct credentials.

Type: CredentialPipeBind
Parameter Sets: Main

Required: False
Position: Named
Accept pipeline input: False

-CurrentCredentials

If you want to connect with the current user credentials

Type: SwitchParameter
Parameter Sets: Main

Required: False
Position: Named
Accept pipeline input: False

-DriveName

Name of the PSDrive to create (default: SPO)

Type: String
Parameter Sets: Main, Token, WebLogin, Azure Active Directory, App-Only with Azure Active Directory, App-Only with Azure Active Directory using certificate as PEM strings, App-Only with Azure Active Directory using certificate from certificate store by thumbprint, App-Only with Azure Active Directory using X502 certificates, SPO Management Shell Credentials, Access Token

Required: False
Position: Named
Accept pipeline input: False

-Graph

Read and write managed metadata
Have full control of all site collections
Read user profiles
Invite guest users to the organization
Read and write all groups
Read and write directory data
Read and write identity providers
Access the directory as you

Only applicable to: SharePoint Online

Type: SwitchParameter
Parameter Sets: PnP Office 365 Management Shell to the Microsoft Graph

Required: True
Position: Named
Accept pipeline input: False

-HighTrustCertificate

The certificate which has been registered in SharePoint as a Trusted Security Token issuer to use for the High Trust connection. Note that CNG key storage providers are not supported.

Only applicable to: SharePoint Server 2019, SharePoint Server 2016, SharePoint Server 2013

Type: X509Certificate2
Parameter Sets: High Trust using a X509Certificate2 object.

Required: True
Position: Named
Accept pipeline input: False

-HighTrustCertificateIssuerId

The IssuerID under which the certificate has been registered in SharePoint as a Trusted Security Token issuer to use for the High Trust connection. Uses the ClientID if not specified.

Only applicable to: SharePoint Server 2019, SharePoint Server 2016, SharePoint Server 2013

Type: String
Parameter Sets: High Trust using a X509Certificate2 object., High Trust using a certificate from a PFX file.

Required: False
Position: Named
Accept pipeline input: False

-HighTrustCertificatePassword

The password of the private key certificate (.pfx) to use for the High Trust connection

Only applicable to: SharePoint Server 2019, SharePoint Server 2016, SharePoint Server 2013

Type: String
Parameter Sets: High Trust using a certificate from a PFX file.

Required: True
Position: Named
Accept pipeline input: False

-HighTrustCertificatePath

The path to the private key certificate (.pfx) to use for the High Trust connection

Only applicable to: SharePoint Server 2019, SharePoint Server 2016, SharePoint Server 2013

Type: String
Parameter Sets: High Trust using a certificate from a PFX file.

Required: True
Position: Named
Accept pipeline input: False

-IgnoreSslErrors

Ignores any SSL errors. To be used i.e. when connecting to a SharePoint farm using self signed certificates or using a certificate authority not trusted by this machine.

Type: SwitchParameter
Parameter Sets: Main, Token, WebLogin, Azure Active Directory, App-Only with Azure Active Directory, App-Only with Azure Active Directory using certificate as PEM strings, App-Only with Azure Active Directory using certificate from certificate store by thumbprint, App-Only with Azure Active Directory using X502 certificates, Microsoft Graph using Azure Active Directory, Microsoft Graph using Scopes, PnP Office 365 Management Shell to the Microsoft Graph, SPO Management Shell Credentials

Required: False
Position: Named
Accept pipeline input: False

-Kerberos

Authenticate using Kerberos to an on-premises ADFS instance.

Type: SwitchParameter
Parameter Sets: Main

Required: False
Position: Named
Accept pipeline input: False

-LaunchBrowser

Launch a browser automatically and copy the code to enter to the clipboard

Only applicable to: SharePoint Online

Type: SwitchParameter
Parameter Sets: PnP O365 Management Shell / DeviceLogin, PnP Office 365 Management Shell to the Microsoft Graph

Required: False
Position: Named
Accept pipeline input: False

-LoginProviderName

The name of the ADFS trusted login provider

Type: String
Parameter Sets: Main

Required: False
Position: Named
Accept pipeline input: False

-MinimalHealthScore

Specifies a minimal server healthscore before any requests are executed.

Type: Int
Parameter Sets: Main, Token, WebLogin, Azure Active Directory, App-Only with Azure Active Directory, App-Only with Azure Active Directory using certificate as PEM strings, App-Only with Azure Active Directory using certificate from certificate store by thumbprint, App-Only with Azure Active Directory using X502 certificates, SPO Management Shell Credentials, Access Token

Required: False
Position: Named
Accept pipeline input: False

-NoTelemetry

In order to help to make PnP PowerShell better, we can track anonymous telemetry. We track the version of the cmdlets you are using, which cmdlet you are executing and which version of SharePoint you are connecting to. Use Disable-PnPPowerShellTelemetry to turn this off in general or use the -NoTelemetry switch to turn it off for that session.

Type: SwitchParameter
Parameter Sets: (All)

Required: False
Position: Named
Accept pipeline input: False

-PEMCertificate

PEM encoded certificate

Only applicable to: SharePoint Online

Type: String
Parameter Sets: App-Only with Azure Active Directory using certificate as PEM strings

Required: True
Position: Named
Accept pipeline input: False

-PEMPrivateKey

PEM encoded private key for the certificate

Only applicable to: SharePoint Online

Type: String
Parameter Sets: App-Only with Azure Active Directory using certificate as PEM strings

Required: True
Position: Named
Accept pipeline input: False

-PnPO365ManagementShell

Read and write managed metadata
Have full control of all site collections
Read user profiles
Invite guest users to the organization
Read and write all groups
Read and write directory data
Read and write identity providers
Access the directory as you

Only applicable to: SharePoint Online

Type: SwitchParameter
Parameter Sets: PnP O365 Management Shell / DeviceLogin

Required: True
Position: Named
Accept pipeline input: False

-Realm

Authentication realm. If not specified will be resolved from the url specified.

Type: String
Parameter Sets: Token

Required: False
Position: Named
Accept pipeline input: False

-RedirectUri

The Redirect URI of the Azure AD Application

Only applicable to: SharePoint Online

Type: String
Parameter Sets: Azure Active Directory

Required: True
Position: Named
Accept pipeline input: False

-RequestTimeout

The request timeout. Default is 1800000

Type: Int
Parameter Sets: Main, Token, WebLogin, Azure Active Directory, App-Only with Azure Active Directory, App-Only with Azure Active Directory using certificate as PEM strings, App-Only with Azure Active Directory using certificate from certificate store by thumbprint, App-Only with Azure Active Directory using X502 certificates, SPO Management Shell Credentials, Access Token

Required: False
Position: Named
Accept pipeline input: False

-RetryCount

Defines how often a retry should be executed if the server healthscore is not sufficient. Default is 10 times.

Type: Int
Parameter Sets: Main, Token, WebLogin, Azure Active Directory, App-Only with Azure Active Directory, App-Only with Azure Active Directory using certificate as PEM strings, App-Only with Azure Active Directory using certificate from certificate store by thumbprint, App-Only with Azure Active Directory using X502 certificates, SPO Management Shell Credentials, Access Token

Required: False
Position: Named
Accept pipeline input: False

-RetryWait

Defines how many seconds to wait before each retry. Default is 1 second.

Type: Int
Parameter Sets: Main, Token, WebLogin, Azure Active Directory, App-Only with Azure Active Directory, App-Only with Azure Active Directory using certificate as PEM strings, App-Only with Azure Active Directory using certificate from certificate store by thumbprint, App-Only with Azure Active Directory using X502 certificates, SPO Management Shell Credentials, Access Token

Required: False
Position: Named
Accept pipeline input: False

-ReturnConnection

Returns the connection for use with the -Connection parameter on cmdlets.

Type: SwitchParameter
Parameter Sets: Main, Token, WebLogin, Azure Active Directory, App-Only with Azure Active Directory, App-Only with Azure Active Directory using certificate as PEM strings, App-Only with Azure Active Directory using certificate from certificate store by thumbprint, App-Only with Azure Active Directory using X502 certificates, SPO Management Shell Credentials, Access Token, PnP O365 Management Shell / DeviceLogin

Required: False
Position: Named
Accept pipeline input: True

-Scopes

The array of permission scopes for the Microsoft Graph API.

Only applicable to: SharePoint Online

Type: String[]
Parameter Sets: Main, Token, WebLogin, Azure Active Directory, App-Only with Azure Active Directory, SPO Management Shell Credentials, Microsoft Graph using Scopes

Required: False
Position: Named
Accept pipeline input: False

-SkipTenantAdminCheck

Should we skip the check if this site is the Tenant admin site. Default is false

Type: SwitchParameter
Parameter Sets: Main, Token, WebLogin, Azure Active Directory, App-Only with Azure Active Directory, App-Only with Azure Active Directory using certificate as PEM strings, App-Only with Azure Active Directory using certificate from certificate store by thumbprint, App-Only with Azure Active Directory using X502 certificates, SPO Management Shell Credentials, Access Token

Required: False
Position: Named
Accept pipeline input: False

-SPOManagementShell

Only applicable to: SharePoint Online

Type: SwitchParameter
Parameter Sets: SPO Management Shell Credentials

Required: True
Position: Named
Accept pipeline input: False

-Tenant

The Azure AD Tenant name,e.g. mycompany.onmicrosoft.com

Only applicable to: SharePoint Online

Type: String
Parameter Sets: App-Only with Azure Active Directory using certificate as PEM strings, App-Only with Azure Active Directory using certificate from certificate store by thumbprint, App-Only with Azure Active Directory, App-Only with Azure Active Directory using X502 certificates

Required: True
Position: Named
Accept pipeline input: False

-TenantAdminUrl

The url to the Tenant Admin site. If not specified, the cmdlets will assume to connect automatically to https://<tenantname>-admin.sharepoint.com where appropriate.

Type: String
Parameter Sets: Main, Token, WebLogin, Azure Active Directory, App-Only with Azure Active Directory, App-Only with Azure Active Directory using certificate as PEM strings, App-Only with Azure Active Directory using certificate from certificate store by thumbprint, App-Only with Azure Active Directory using X502 certificates, SPO Management Shell Credentials

Required: False
Position: Named
Accept pipeline input: False

-Thumbprint

Certificate thumbprint

Only applicable to: SharePoint Online

Type: String
Parameter Sets: App-Only with Azure Active Directory using certificate from certificate store by thumbprint

Required: True
Position: Named
Accept pipeline input: False

-Url

The Url of the site collection to connect to.

Type: String
Parameter Sets: Main, Token, WebLogin, Azure Active Directory, App-Only with Azure Active Directory, App-Only with Azure Active Directory using certificate as PEM strings, App-Only with Azure Active Directory using X502 certificates, App-Only with Azure Active Directory using certificate from certificate store by thumbprint, SPO Management Shell Credentials, Access Token, PnP O365 Management Shell / DeviceLogin

Required: True
Position: 0
Accept pipeline input: True

-UseAdfs

If you want to connect to your on-premises SharePoint farm using ADFS

Type: SwitchParameter
Parameter Sets: Main

Required: False
Position: Named
Accept pipeline input: False

-UseAdfsCert

If you want to connect to your SharePoint farm using ADFS with Certificate Authentication

Type: SwitchParameter
Parameter Sets: Main

Required: False
Position: Named
Accept pipeline input: False

-UserName

Name of the user (login name) on whose behalf to create the access token. Supported input formats are SID and User Principal Name (UPN) in the format user@domain.local. If the parameter is not specified, an App Only Context is created.

Only applicable to: SharePoint Server 2019, SharePoint Server 2016, SharePoint Server 2013

Type: String
Parameter Sets: High Trust using a X509Certificate2 object., High Trust using a certificate from a PFX file.

Required: False
Position: Named
Accept pipeline input: False

-UseWebLogin

If you want to connect to SharePoint with browser based login. This is required when you have multi-factor authentication (MFA) enabled.

Type: SwitchParameter
Parameter Sets: WebLogin

Required: True
Position: Named
Accept pipeline input: False

MicrosoftDocs / office-docs-powershell

Join GitHub today

office-docs-powershell/sharepoint/sharepoint-ps/sharepoint-pnp/Connect-PnPOnline.md

Connect-PnPOnline

SYNOPSIS

SYNTAX

Main

Access Token

PnP Office 365 Management Shell to the Microsoft Graph

Microsoft Graph using Scopes

WebLogin

SPO Management Shell Credentials

PnP O365 Management Shell / DeviceLogin

Token

Azure Active Directory

App-Only with Azure Active Directory

App-Only with Azure Active Directory using X502 certificates

Microsoft Graph using Azure Active Directory

High Trust using a X509Certificate2 object.

App-Only with Azure Active Directory using certificate from certificate store by thumbprint

High Trust using a certificate from a PFX file.

App-Only with Azure Active Directory using certificate as PEM strings

DESCRIPTION

EXAMPLES

------------------EXAMPLE 1------------------

------------------EXAMPLE 2------------------

------------------EXAMPLE 3------------------

------------------EXAMPLE 4------------------

------------------EXAMPLE 5------------------

------------------EXAMPLE 6------------------

------------------EXAMPLE 7------------------

------------------EXAMPLE 8------------------

------------------EXAMPLE 9------------------

------------------EXAMPLE 10------------------

------------------EXAMPLE 11------------------

------------------EXAMPLE 12------------------

------------------EXAMPLE 13------------------

------------------EXAMPLE 14------------------

------------------EXAMPLE 15------------------

------------------EXAMPLE 16------------------

------------------EXAMPLE 17------------------

------------------EXAMPLE 18------------------

------------------EXAMPLE 19------------------

------------------EXAMPLE 20------------------

------------------EXAMPLE 21------------------

------------------EXAMPLE 22------------------

------------------EXAMPLE 23------------------

------------------EXAMPLE 24------------------

------------------EXAMPLE 25------------------

PARAMETERS

-AADDomain

-AccessToken

-AppId

-AppSecret

-AuthenticationMode

-AzureEnvironment

-Certificate

-CertificateBase64Encoded

-CertificatePassword

-CertificatePath

-ClearTokenCache

-ClientId

-CreateDrive

-Credentials

-CurrentCredentials

-DriveName

-Graph

-HighTrustCertificate

-HighTrustCertificateIssuerId

-HighTrustCertificatePassword

-HighTrustCertificatePath

-IgnoreSslErrors

-Kerberos

-LaunchBrowser

-LoginProviderName

-MinimalHealthScore

-NoTelemetry

-PEMCertificate

-PEMPrivateKey

-PnPO365ManagementShell