Add Custom OAuth

Add custom OAuth service

URLRequires AuthHTTP Method

/api/v1/settings.addCustomOAuth

Yes

POST

Payload

ArgumentExampleRequiredDescription

name

New OAuth

Required

The name of the Oauth.

Example Call

curl --location --request POST 'http://localhost:3000/api/v1/settings.addCustomOAuth' \
--header 'X-Auth-Token: eT9kwwdHSNJX5Sw7Ce_M0IcTuO5HOfDkyZwdXGfgAvy' \
--header 'X-User-Id: Dtx5kwoQJGYQSw3Qh' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "New OAuth"
}'

Result

Success

{
    "success": true
}

Errors

The following error can occur on the endpoint.

  • Authorization: Requires an authentication token for the request to be made.

  • Param not provided: Occurs when the name parameter is not provided.

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

Last updated

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