Update OAuth App

URLRequires AuthHTTP Method

/api/v1/oauth-apps.update

POST

Permission required: manage-oauth-apps

Body Parameters

KeyExample ValueDescription

appId*

65a7d77142a7e12453052d59

The OAuth app ID.

name*

test-oauth-app

The app name that you want to update.

active*

true

Whether the app will be active or not. Enter a boolean value, true or false..

redirectUri*

https://testuri.com

The URL to redirect the OAuth app.

Example Call

curl 'http://localhost:3000/api/v1/oauth-apps.create' \
  -H 'Content-Type: application/json' \
  -H 'X-Auth-Token: G1xiui60uWU3A2sRuv0seG3zVKpphJls3NuXVFNDH_o' \
  -H 'X-User-Id: YA5aSHTjZNJEGKHhK' \
  --data-raw '{
        "name": "test-oauth-app",
        "redirectUri": "https://testuri.com",
        "active": true,
        "appId": "65a7d77142a7e12453052d59" }'

Example Response

{
  "_id": "65a7d77142a7e12453052d59",
  "name": "test-oauth-app2",
  "redirectUri": "https://testuri2.com",
  "active": false,
  "clientId": "fxHAgLRjP3RswMe67",
  "clientSecret": "QwIAYE1_8M02p-Js8SHZyTPg7HpJm-1ZtbjuSp8bXpP",
  "_createdAt": "2024-01-17T13:34:41.445Z",
  "_updatedAt": "2024-01-17T13:37:16.966Z",
  "_createdBy": {
    "_id": "JFTcMhEAFbNPfnp49",
    "username": "matheus.barbosa"
  },
  "_updatedBy": {
    "_id": "JFTcMhEAFbNPfnp49",
    "username": "matheus.barbosa"
  },
  "success": true
}

Last updated

Rocket.Chat versions receive support for six months after release.