PIpipedream

Create OAuth client

Changed on

Register a custom OAuth client for an app

post/v1/connect/{project_id}/oauth_apps

Request

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

Request body

appstring required

The app's ID or name slug. The app must have custom OAuth clients enabled.

client_idstring

The OAuth client ID registered with the upstream provider. Optional: providers that only issue credentials once they have a callback URL can be registered without one, and the client cannot connect accounts until it is set.

client_secretstring

The OAuth client secret. Optional, like the client ID. Write-only; never returned in responses.

namestring

Display name of the OAuth client

descriptionstring

Description of the OAuth client

scopesstring[]

OAuth scopes to request when users connect through this client

additional_scopesstring[]

A second scope list to request alongside scopes. Its meaning depends on the app; the app's scope_labels names both lists. If omitted, the client uses the app's Pipedream official client's additional scopes.

Response

OAuth client created

idstring nullable required

Hash ID for the OAuth client

name_slugstring required

The name slug of the target app (see https://pipedream.com/docs/connect/quickstart#find-your-apps-name-slug)

namestring required

The human-readable name of the app

auth_type'keys' | 'oauth' | 'none' nullable

The authentication type used by the app

descriptionstring nullable

A short description of the app

img_srcstring required

The URL to the app's logo

custom_fields_jsonstring nullable required

A JSON string representing the custom fields for the app

categoriesstring[] required

Categories associated with the app

featured_weightnumber required

A rough directional ordering of app popularity, subject to changes by Pipedream

oauth_app_idstring nullable

ID of the app's Pipedream official OAuth client, or null if the app doesn't use OAuth or has no official client. Useful for retrieving the OAuth client's client_id and redirect URI with the Retrieve OAuth client endpoint.

scopesstring[] nullable

The OAuth scopes requested when an account connects through this OAuth client, or, on an app, through the app's Pipedream official OAuth client and no oauth_scope_profile. null when the app doesn't use OAuth or has no official client. Absent when the app is embedded in another resource, such as an account.

additional_scopesstring[] nullable

A second list of scopes requested alongside scopes. The connection does not require the user to grant them. scope_labels names both lists. null when there are none, or when the app doesn't use OAuth or has no official client. Absent when the app is embedded in another resource, such as an account.

client_idstring nullable required

The OAuth client ID registered with the upstream provider. Null for a client registered before its provider issued credentials.

redirect_uristring

The redirect URI to register with the upstream OAuth provider

owner_idstring nullable required

Hash ID of the owner: the workspace (o_...) or the project (proj_...). Null for Pipedream official clients.

created_atstring date-time
updated_atstring date-time

Changes

  • b5c4b07064c6Revision changes
    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from 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

  • 5bf041f14074Revision changes
    • breaking

      the response property / became nullable for the status

    • breaking

      the response property / became nullable for the status

    • info

      the request property became optional

    • info

      the request property became optional

    • info

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