Cmdlets for SuiteCRM

Build 22.0.8462

OAuthVerifier Parameter (Connect-SuiteCRM Cmdlet)

The verifier code returned from the OAuth authorization URL.

Syntax

Connect-SuiteCRM -OAuthVerifier string

Data Type

cstr

Default Value

""

Remarks

The verifier code returned from the OAuth authorization URL. This can be used on systems where a browser cannot be launched such as headless systems.

Authentication on Headless Machines

See Establishing a Connection to obtain the OAuthVerifier value.

Set OAuthSettingsLocation along with OAuthVerifier. When you connect, the cmdlet exchanges the OAuthVerifier for the OAuth authentication tokens and saves them, encrypted, to the specified file.

Once the OAuth settings file has been generated, you can remove OAuthVerifier from the connection properties and connect with OAuthSettingsLocation set.

To automatically refresh the OAuth token values, set OAuthSettingsLocation and additionally set InitiateOAuth to REFRESH.

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