Get Authentication

Request

Overview

Use this API to get details of existing Authentication types in the Conversation Manager.

Scope

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

Security

oAuthClient(Required scopes: )

Path

idstring, = 36 charactersrequired

id of object

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

curl -i -X GET \
  https://api.egain.cloud/conversation/conversationmgr/v3/authentications/7b6c5fff-036e-4a40-b68a-a67c592fc079 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/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

idstring, = 36 characters

createdstring, (date-time)

Last modified time in GMT

modifiedstring, (date-time)

Last modified time in GMT

namestring, [ 1 .. 255 ] charactersrequired

Unique name for authentication method

descriptionstring, [ 1 .. 1023 ] characters

activeboolean

Default:true

typestringrequired

Type of authentication

Value:"oauth2"

Example:"oauth2"

oauth2objectrequired

Response

{
  "id": "34fbb53f-ed7f-48d4-b545-e26cc95e075d",
  "name": "custom_bot_callback_authentication",
  "type": "oauth2",
  "oauth2": {
    "tokenRequestUrl": "https://acme.support.com/clientapp/accesstoken",
    "method": "POST",
    "headers": [ … ],
    "payload": "{ \"clientId\": \"c987cbfc-d59c-11ea-87d0-0242ac130003\",\"clientSecret\": \"c987cde6-d59c-11ea-87d0-0242ac130003\",\"refreshToken\": \"c987cee0-d59c-11ea-87d0-0242ac130003\"}",
    "accessTokenPath": "$.accessToken"
  },
  "created": "2021-03-28T14:29:01.516Z",
  "modified": "2021-03-28T14:29:01.516Z"
}