Remove OAuth Service

Remove an OAuth service.

NameRequires AuthPermissionSetting

removeOAuthService

Yes

add-oauth-service

None

Payload Parameters

Argument

Example

Required

Description

name

okta

Required

The name of the OAuth service you want to remove.

Example call

{
    "msg": "method",
    "method": "removeOAuthService",
    "id": "2",
    "params": [
        "Zapier"
    ]
}

Example Response

Success

{
    "msg": "result",
    "id": "2"
}

Error

Any of the following errors can occur on the endpoint.

  • No Permission: Occurs when the authenticated user doesn't have the add-oauth-service permission.

{
    "msg": "result",
    "id": "2",
    "error": {
        "isClientSafe": true,
        "error": "error-not-allowed",
        "reason": "Not allowed",
        "details": {
            "method": "removeOAuthService"
        },
        "message": "Not allowed [error-not-allowed]",
        "errorType": "Meteor.Error"
    }
}

Last updated

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