Cmdlets for Xero

Build 22.0.8479

AuthScheme Parameter (Connect-Xero Cmdlet)

The type of authentication to use when connecting to Xero.

Syntax

Connect-Xero -AuthScheme string

Possible Values

Auto, OAuth, PKCE, OAuthClient

Data Type

cstr

Default Value

"PKCE"

Remarks

Current authentication methods supported for new apps:

  • OAuth: Authenticates you using OAuth with a client ID and secret. Should be used with server-side applications.
  • PKCE: Authenticates you using OAuth with only a client ID. Should be used with client-side applications.
  • OAuthClient: Authenticates you using client credentials with a client ID and secret. Can only be used if you have purchased a Custom Connection license from Xero.
  • Auto: Uses the value of the XeroAppAuthentication property to determine the authentication mode. XeroAppAuthentication is included only for backwards compatibility and all new connections should use a different AuthScheme property.

This is a required parameter.

Copyright (c) 2023 CData Software, Inc. - All rights reserved.
Build 22.0.8479