Get OAuth App

Prev Next
Get
/api/v1/oauth-apps.get

Retrieves an OAuth app by ID or client ID.

Permission required: manage-oauth-apps. The endpoint can be accessed even without this permission, but sensitive information (such as client secrets) will be filtered out.

Changelog

Version Description
2.4.0 Added
Header parameters
X-Auth-Token
stringRequired

The authorization token of the user.

Example9HqLlyZOugD_0YdwAJF8V47U3QHXSq
X-User-Id
stringRequired

The user ID of the user.

ExampleaobEdbYhXfu5hkeqG
Query parameters
appId
string

The app ID. This value is required if clientId is not used.

The parameter will stop being accepted from 7.0.0 (use the clientId or _id parameters instead).

Examplejn32kjnnd0943j4njk
clientId
string

The client ID. This value is required if appId is not used.

Examplenkn8jk67b8b99b78
_id
string

The app ID. This value is required if clientId is not used.

Responses
200
Example 1
{
  "oauthApp": {
    "_id": "zapier",
    "name": "Zapier",
    "active": true,
    "clientId": "zapier",
    "clientSecret": "RTK6TlndaCIolhQhZ7_KHIGOKj41RnlaOq_o-7JKwLr",
    "redirectUri": "https://zapier.com/dashboard/auth/oauth/return/RocketChatDevAPI/",
    "_createdAt": "2019-10-17T22:55:32.787Z",
    "_createdBy": {
      "_id": "system",
      "username": "system"
    },
    "_updatedAt": "2019-10-17T22:55:32.787Z"
  },
  "success": true
}
Expand All
object
oauthApp
object
_id
string
name
string
active
boolean
clientId
string
clientSecret
string
redirectUri
string
_createdAt
string
_createdBy
object
_id
string
username
string
_updatedAt
string
success
boolean
400

Bad Request

Example 1
{
  "success": false,
  "error": "must have required property '_id'\n must have required property 'clientId'\n must have required property 'appId'\n must match exactly one schema in oneOf [invalid-params]",
  "errorType": "invalid-params"
}
Example 2
{
  "success": false,
  "error": "OAuth app not found."
}
object
success
boolean
error
string
errorType
string
401

Unauthorized

Authorization Error
{
  "status": "error",
  "message": "You must be logged in to do this."
}
object
status
string
message
string