PIpipedream

Create Connect token

Changed on

Generate a Connect token to use for client-side authentication

post/v1/connect/{project_id}/tokens

Request

  • Base URL
    https://api.pipedream.com
  • URL
    https://api.pipedream.com/v1/connect/{project_id}/tokens
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://api.pipedream.com/v1/oauth/token

Headers

x-pd-environment'development' | 'production' required

The environment in which the server client is running

Request body

allowed_originsstring[]

List of allowed origins for CORS

error_redirect_uristring

URI to redirect to on error

expires_ininteger

Token TTL in seconds (max 14400 = 4 hours). Defaults to 4 hours if not specified.

external_user_idstring required

Your end user ID, for whom you're creating the token

scopestring

Space-separated scopes to restrict token permissions. Defaults to 'connect:*' if not specified. See https://pipedream.com/docs/connect/api-reference/authentication#connect-token-scopes for more information.

success_redirect_uristring

URI to redirect to on success

webhook_uristring

Webhook URI for notifications

allow_progressive_scopesboolean

When true, end users may authorize a subset of the app's OAuth scopes; only the app's functional scopes (needed for the post-OAuth test request) are enforced. Defaults to false.

app_idstring

Scope the Connect Link to this app, identified by app ID or name slug: resolves the app's official OAuth client for your workspace (when it has one) and pins the link to the host serving that client's OAuth flow pages. Optional.

oauth_app_idstring

Scope the Connect Link to a specific OAuth client (overrides app_id's resolution). Optional.

Response

connect token created

connect_link_urlstring required

The Connect Link URL

expires_atstring date-time required

The expiration time of the token in ISO 8601 format

tokenstring required

An authentication token with a limited lifespan

Changes

  • 5bf041f14074Revision changes
    • info

      added the new optional request property

    • info

      added the new optional request property