Add a custom OAuth integration to your workspace. Two-factor authentication is required.
From Rocket.Chat 9.0.0, Custom OAuth is available on Starter workspaces and on all premium plans (Commercial, Government, and Defense). It is not available on Community workspaces, where this endpoint returns error-action-not-allowed. See Our Plans for details.
Permission required:
add-oauth-service
Changelog
| Version | Description |
|---|---|
| 9.0.0 | Added premium plan availability details. |
The user ID.
The authentication token.
The 2FA code. This parameter is required if 2FA is enabled in your workspace. See the Introduction to Two-Factor Authentication document for details.
Enter the method with which you get the 2FA code. It can be email, totp, or password. This parameter is required if 2FA is enabled in your workspace.
The name of the custom OAuth method that you want to add.
OK
{
"success": true
}Bad Request
{
"success": false,
"error": "The parameter \"name\" is required [error-name-param-not-provided]",
"errorType": "error-name-param-not-provided"
}{
"success": false,
"error": "This is an enterprise feature [error-action-not-allowed]",
"errorType": "error-action-not-allowed"
}Unauthorized
{
"success": false,
"error": "You must be logged in to do this."
}Forbidden
{
"success": false,
"error": "User does not have the permissions required for this action",
"errorType": "error-forbidden"
}