PIpipeshub-ai
OAuth Configuration

List OAuth configs for connector type

Changed on

List the organization's OAuth configurations for one connector type.<br><br> <b>What comes back depends on the caller:</b><br>

<ul> <li>An admin gets each stored record in full, including `config` with the client secret in clear text</li> <li>Any other caller gets only the credential-free fields</li> </ul> A connector type with no configurations, or one that does not exist, yields an empty list.
get/oauth/{connectorType}

Request

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

Path parameters

connectorTypestring required

Query parameters

scope'team' | 'personal'

Scope determines visibility and access control for connectors:<br>

<ul> <li><code>team</code> - Available to all users in the organization (admin-only creation)</li> <li><code>personal</code> - Private to the creating user only</li> </ul>
Example:team

Only OAuth apps usable for this connector scope

pageinteger
limitinteger
searchstring

Space-separated terms; every term must appear in the name, connector type, group, description or categories

reveal'true'

Set to true to receive stored secrets instead of placeholders. Honoured only for an admin's own configuration where the deployment allows it (see GET /configurationManager/secretReveal); ignored for OAuth-app tokens and any other value.

Response

Saved OAuth apps

successboolean required

Example response

{
  "oauthConfigs": [
    {
      "connectorType": "Confluence",
      "iconPath": "/icons/connectors/confluence.svg",
      "appGroup": "Atlassian",
      "redirectUri": "http://localhost:3001/connectors/oauth/callback/Confluence",
      "tokenAccessType": "offline",
      "additionalParams": {
        "access_type": "offline",
        "prompt": "consent"
      },
      "scopeParameterName": "user_scope",
      "tokenResponsePath": "authed_user"
    }
  ]
}

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

    • breaking

      the / response's property type changed from object to no type for status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • 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 non-success response with the status

    • info

      added subschema #2 to the / response property allOf list for the response status

  • a44792e4f0e6Revision changes
    • info

      endpoint added