PIpipeshub-ai
OAuth Configuration

List OAuth-capable connector types

Changed on

List the connector and toolset types that support OAuth, from the OAuth registry.<br><br> Each entry carries the provider URLs, the scopes requested, and the authFields to collect when creating an OAuth configuration for that type.<br><br> Any authenticated user can call this; it is not limited to admins.

get/oauth/registry

Request

  • Base URL
    https://app.pipeshub.com/api/v1
  • URL
    https://app.pipeshub.com/api/v1/oauth/registry
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization code: /api/v1/oauth2/authorize
      Client credentials
      Token URL: /api/v1/oauth2/token scopes: connector:read

Query parameters

pageinteger
limitinteger
searchstring

Matches the connector type's name, group or description

Response

OAuth connector types retrieved

successboolean required

Example response

{
  "connectors": [
    {
      "name": "Jira",
      "type": "Jira",
      "appGroup": "Atlassian",
      "authType": "OAUTH",
      "iconPath": "/icons/connectors/jira.svg",
      "redirectUri": "connectors/oauth/callback/Jira",
      "tokenAccessType": "offline",
      "authFields": [
        {
          "name": "clientId"
        }
      ]
    }
  ]
}

Changes

  • dbb5e203b445Revision changes
    • breaking

      the response property / became optional for the status

    • breaking

      the response property / became optional for the status

    • breaking

      the response property / became optional for the status

    • breaking

      the response property / became optional for the status

    • breaking

      the response property / became optional for the status

    • breaking

      the response property / became optional for the status

    • info

      added the non-success response with the status

  • a44792e4f0e6Revision changes
    • info

      endpoint added