Permission Entity APIs

Get Permission Entities

This API lists all the permission entities associated with a connector.

Method	GET
Endpoint	<host_url>/api/public/bot/:botId/connector/:connectorId/permission-entities
Content-Type	application/json
Authorization	auth: <JWT Token>
API Scope	Permission Entity Management

Query Parameters

Parameters	Description	Mandatory
Bot ID	Provide your application ID here.	Yes
Connector ID	Unique ID of the connector for which permission entities are requested.	Yes
Skip	No of records to skip from the beginning of the response	No
Limit	Maximum number of records to return in the response	No

Get Permission Entity by ID

This API returns the details of the request permission entity. It lists the users associated with the permission entity.

Method	GET
Endpoint	<host_url>/api/public/bot/:botId/connector/:connectorId/permission-entities/:entityId
Content-Type	application/json
Authorization	auth: <JWT Token>
API Scope	Permission Entity Management

Query Parameters

Parameters	Description	Mandatory
Bot ID	Provide your application ID here.	Yes
Connector ID	Unique ID of the connector for which permission entities are requested.	Yes
Entity Id	Unique Id of the Permission Entity	Yes

Update Permission Entity by ID

This API is used to associate users to a Permission Entity. You can add new users to the entity using this API.

Method	PUT
Endpoint	<host_url>/api/public/bot/:botId/connector/:connectorId/permission-entities/:entityId
Content-Type	application/json
Authorization	auth: <JWT Token>
API Scope	Permission Entity Management

Query Parameters

Parameters	Description	Mandatory
Stream ID	Provide your application ID here.	Yes
Connector ID	Unique ID of the connector for which permission entities is to be updated.	Yes
Entity Id	Unique Id of the Permission Entity	Yes

Sample Request Body

To associate a user with a permission entity, use the following as the request body.

{
"userList":["john@kore.com"]
}

Delete Users from Permission Entity by ID

This API removes a user already associated with the permission entity.

Method	DELETE
Endpoint	<host_url>/api/public/bot/:botId/connector/:connectorId/permission-entities/:entityId
Content-Type	application/json
Authorization	auth: <JWT Token>
API Scope	Permission Entity Management

Query Parameters

Parameters	Description	Mandatory
Stream ID	Provide your application ID here.	Yes
Connector ID	Unique ID of the connector for which permission entities is to be updated.	Yes
Entity Id	Unique ID of the Permission Entity	Yes

Sample Request Body

To delete a user from a permission entity, use the following as the request body.

{
    "userList":["john@kore.com"]
}