Create Authentication

Overview

Use this API to register client callback Authentication methods using oAuth or Basic Authentication. This is the first step in creating a new Conversation Account. New Account API process flow: Authenticiation > Client Application > Participant > Channel > Orchestration > Account Use the ID returned in the response when creating the client application. The Conversation Manager also uses this authentication method when sending messages to the callback URL of the client application.

Scope

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

SecurityoAuthClient

Request

Request Body schema: application/json

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

Responses

201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal server error

post/authentications

Request samples

Payload
curl
JavaScript
Node.js

application/json

OAuth type authentication

{"name": "custom_bot_callback_authentication",
"type": "oauth2",
"oauth2": {"tokenRequestUrl": "https://example.com/accesstoken",
"method": "POST",
"headers": [{"name": "Content-Type",
"value": "application/json"
},
{"name": "Accept",
"value": "application/json"
}
],
"payload": "{ \"clientId\": \"74513d54e112464ea8e69d3d639d0c94\",\"clientSecret\": \"nv1GRtTAL1OcKdqKZrQBb5AqQNilgaitr@JYtsdYZvLbCHx8dRjZeCPENmo8\"}",
"accessTokenPath": "$.accessToken"
}
}

Response samples

application/json

{"id": "34fbb53f-ed7f-48d4-b545-e26cc95e075d"
}