PIpipeshub-ai
OAuth Apps

Get OAuth app details

Changed on

Returns the full configuration of an OAuth app you registered. The clientSecret is never echoed back here; if you need a new one, call POST /oauth-clients/{appId}/regenerate-secret.

Access is creator-scoped: even org admins receive 404 for apps owned by other users. This avoids leaking app metadata across org members and keeps the read surface symmetric with listOAuthApps.

get/oauth-clients/{appId}

Request

  • Base URL
    https://app.pipeshub.com/api/v1
  • URL
    https://app.pipeshub.com/api/v1/oauth-clients/{appId}
  • Auth
    HTTP bearer

Path parameters

appIdstring required

OAuth app ID (MongoDB ObjectId)

Response

OAuth app details

idstring required

App ID

slugstring required

URL-friendly app slug

clientIdstring required

OAuth client ID

namestring required

App name

descriptionstring

App description

redirectUrisstring[] required

Allowed redirect URIs (always returned; may be empty)

allowedGrantTypesstring[] required

Allowed grant types

allowedScopesstring[] required

Allowed scopes

status'active' | 'suspended' | 'revoked' required

App status

homepageUrlstring uri

App homepage

privacyPolicyUrlstring uri

Privacy policy URL

termsOfServiceUrlstring uri

Terms of service URL

isConfidentialboolean required

Whether app is a confidential client

accessTokenLifetimeinteger required

Access token lifetime in seconds

refreshTokenLifetimeinteger required

Refresh token lifetime in seconds

tokenIdentityUserIdstring

The service account this app's own client_credentials tokens act as.

Absent means the app has no service account and its tokens act as whoever created it. Apps registered since a service account became required always have one; an older app may not, and those are the ones an administrator still has to move.

createdAtstring date-time required

Creation timestamp

updatedAtstring date-time required

Last update timestamp

Example response

{
  "tokenIdentityUserId": "65f0c0ffee00000000000000"
}

Changes

  • dbb5e203b445Revision changes
    • info

      added the non-success response with the status

    • info

      added the non-success 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

  • fc76aa045994Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status