PIpipedream

Validate Connect token

Changed on

Confirm the validity of a Connect token

get/v1/connect/tokens/{ctok}/validate

Request

  • Base URL
    https://api.pipedream.com
  • URL
    https://api.pipedream.com/v1/connect/tokens/{ctok}/validate
  • Auth
    none declared

Path parameters

ctokstring required

An authentication token with a limited lifespan

Query parameters

app_idstring

The app ID to validate against. Required unless account_id or app_override_id identifies the app.

account_idstring

An existing account ID to reconnect. Must belong to the app identified by app_id.

oauth_app_idstring

The OAuth app ID to validate against (if the token is for an OAuth app)

app_override_idstring

An app override ID. Selects the override's app, pre-defined custom fields, and OAuth client. With account_id, re-links the account to this override; it must belong to the account's app, and an override that pins a different OAuth client switches the account to that client when the reconnect flow completes. A conflicting app_id or oauth_app_id is an error. To resolve an override by name, list them with GET /v1/connect/{project_id}/app_overrides and match on name.

Response

connect token validated

app_override_idstring nullable

ID of the resolved app override, echoed from the request

app_override_field_namesstring[] nullable

Names of the custom fields the resolved app override pre-defines

errorstring nullable required

Error message if validation failed

error_redirect_uristring nullable

URI to redirect to on error

oauth_app_idstring nullable

OAuth app ID if applicable

oauth_app_workday_officialboolean

True when the resolved OAuth client is the app's Workday-official client

oauth_app_connect_base_urlstring nullable

Base URL the Connect UI must run this client's OAuth flow on; null means the default API URL

project_app_namestring nullable

Name of the project app

project_environmentstring nullable

Environment of the project

project_idstring nullable

ID of the project

project_support_emailstring nullable

Support email for the project

successboolean required

Whether the token validation was successful

success_redirect_uristring nullable

URI to redirect to on success

Changes

  • b5c4b07064c6Revision changes
    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

  • 5bf041f14074Revision changes
    • info

      added the new optional query request parameter app_override_id

    • info

      the query request parameter app_id became optional

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status