Update Authentication

Overview

Use this API to update an existing authentication type.

Scope

Client application must have 'app.conversation.conversationmgr.manage' scope assigned.

SecurityoAuthClient

Request

path Parameters

required

string = 36 characters

id of object

Example: 7b6c5fff-036e-4a40-b68a-a67c592fc079

Request Body schema: application/json

Update authentication type

One of:

OAuth type authentication for callback APIs specified in Client application. Conversation Hub will generate token using this API and use it until it receives 401 from callback API

name required	string [ 1 .. 255 ] characters Unique name for authentication method
description	string [ 1 .. 1023 ] characters
active	boolean Default: true
type required	string Type of authentication Value: "oauth2"
required	object
modified	string <date-time> Last modified time in GMT

Responses

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal server error

put/authentications/{id}

Request samples

Payload
curl
JavaScript
Node.js

application/json

{"name": "custom_bot_callback_authentication",
"type": "oauth2",
"oauth2": {"tokenRequestUrl": "https://acme.support.com/clientapp/accesstoken",
"method": "POST",
"headers": [{"name": "Content-Type",
"value": "application/json"
},
{"name": "Accept",
"value": "application/json"
}
],
"payload": "{ \"clientId\": \"c987cbfc-d59c-11ea-87d0-0242ac130003\",\"clientSecret\": \"c987cde6-d59c-11ea-87d0-0242ac130003\",\"refreshToken\": \"c987cee0-d59c-11ea-87d0-0242ac130003\"}",
"accessTokenPath": "$.accessToken"
},
"modified": "2021-03-28T14:29:01.516Z"
}

Response samples

application/json

Required attribute is missing in payload

{"code": "400-143",
"developerMessage": "Required attribute is missing in the request body: <attribute>"
}