Cmdlets for Microsoft SharePoint

Build 24.0.8963

AuthScheme Parameter (Connect-SharePoint Cmdlet)

The scheme used for authenticating to SharePoint.

Syntax

Connect-SharePoint -AuthScheme string

Possible Values

AzureAD, AzureServicePrincipalCert, AzurePassword, AzureMSI, PingFederate, ADFS, OneLogin, Okta, SharePointOAuth, NTLM, Basic, OAuth, OAuthJWT, Negotiate, None

Data Type

cstr

Default Value

"NTLM"

Remarks

If authenticating to Sharepoint On-Premise instance, together with Password and User, this field is used to authenticate against the server. NTLM is the default option. Use the following options to select your authentication scheme:

  • NTLM: Set this to use your Windows credentials for authentication.
  • Negotiate: If AuthScheme is set to Negotiate, the cmdlet will Negotiate an authentication mechanism with the server. Set AuthScheme to Negotiate if you want to use Kerberos authentication.
  • None: Set this to use anonymous authentication; for example, to access a public site.
  • Basic: Set this to use HTTP Basic authentication.
  • ADFS: Set this to use Single Sign-On authentication with ADFS.

If authenticating to Sharepoint Online, AzureAD is the default option. Use the following options to select your authentication scheme:

  • AzureAD: Set this to perform Azure Active Directory OAuth Authentication.
  • AzureServicePrincipalCert: Set this to authenticate as an Azure Service Principal using a certificate.
  • AzurePassword: Set this to authenticate using OAuth with Password GrantType.
  • PingFederate: Set this to use Single Sign-On authentication with PingFederate.
  • ADFS: Set this to use Single Sign-On authentication with ADFS.
  • OneLogin: Set this to use Single Sign-On authentication with OneLogin.
  • OKTA: Set this to use Single Sign-On authentication with OKTA.
  • AzureMSI: Set this to automatically obtain Managed Service Identity credentials when running on an Azure VM.
  • SharePointOAuth: Set this to use OAuth authentication with Sharepoint APP for Client Credentials.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.8963