Cmdlets for GraphQL

Build 23.0.8839

InitiateOAuth Parameter (Connect-GraphQL Cmdlet)

Set this property to initiate the process to obtain or refresh the OAuth access token when you connect.


Connect-GraphQL -InitiateOAuth string

Possible Values


Data Type


Default Value



The following options are available:

  1. OFF: Indicates that the OAuth flow will be handled entirely by the user. An OAuthAccessToken will be required to authenticate.
  2. GETANDREFRESH: Indicates that the entire OAuth Flow will be handled by the cmdlet. If no token currently exists, it will be obtained by prompting the user via the browser. If a token exists, it will be refreshed when applicable.
  3. REFRESH: Indicates that the cmdlet will only handle refreshing the OAuthAccessToken. The user will never be prompted by the cmdlet to authenticate via the browser. The user must handle obtaining the OAuthAccessToken and OAuthRefreshToken initially.

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