Create or update inbound authentication

This endpoint is used to create or update inbound authentication of an installed integration.

Leave Feedback

URL

POST https://{api-url}/api/v2/tenants/{tenantId}/integrations/installed/{installedIntgId}/inbound/authentication

Sample URL

https://{api-url}/api/v2/tenants/client_8/integrations/installed/INTG-41f10ebb-c5c8-4ab5-838e-beb275d1390f/inbound/authentication

Parameters

<
FieldData TypeValuesDescription
authTypeStringWEBHOOK, OAUTH2Authentication type.
roleString(Optional) Role of the user. Mandatory only when the installed category is selected as Custom.Use default user role for other installed categories.
uniqueIdString(Optional) Unique ID of the role. For information about unique ID of the role, see Search Roles API.

Status code

200 OK

Create or update with authentication type OAUTH2

Sample request

{
	"authType": "OAUTH2"
}

Sample response

{
	"authType": "OAUTH2",
	"apiKeyPairs": [{
		"key": "EkWCgfV465DhFd7BBeWEhQXrmXYsD5Qj"
	}]
}

Create or update with authentication type WEBHOOK

Sample request

{
	"authType": "WEBHOOK"
}

Sample response

{
	"authType": "WEBHOOK",
	"token": "gvKnS9rPErNmYhUrBZE4EnXBWhGN9zb4"
}