OAuth Apps

Suspend OAuth app

Changed on

Moves an OAuth app to status: "suspended", blocking new token issuance at POST /oauth2/token and the authorization-code consent flow. Tokens that have already been issued remain valid until their natural expiry — call POST /oauth-clients/{appId}/revoke-all-tokens immediately afterwards if you need an immediate lockout.

Use this for temporary suspensions where you intend to reactivate later. For permanent removal, use DELETE /oauth-clients/{appId}. Suspending an app that is already suspended returns 400.

Creator-only.

post/oauth-clients/{appId}/suspend

Request

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

Path parameters

appIdstring required

OAuth app ID

Response

OAuth app suspended

messagestring required

Example response

{
  "message": "OAuth app suspended successfully",
  "app": {
    "tokenIdentityUserId": "65f0c0ffee00000000000000"
  }
}

Changes

    • 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

    • 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