Get Permission Entities
This API lists all the permission entities associated with a connector.
| Method | GET |
| Endpoint | <host_url>/searchassistapi/external/stream/<stream-id>/connector/<connector-id>/permission_entities |
| Content-Type | application/json |
| Authorization | auth: <JWT Token> |
| API Scope | user_association |
Query Parameters
| Parameters | Description | Mandatory |
| Stream 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 |
Sample Response
[ { "_id": "fpe-1e964f98-68cf-5b5e-802d-0f4c88577c52", "searchIndexId": "sidx-1a03bc64-a17c-59f7-ba81-6a9be27a08db", "entity": "fd8f94c3b58b8110f8779c9460b514ce", "userIds": [ "searchAI@kore.com" ], "blocklist": [], "whitelist": [], "meta": {}, "SHA": "eyJtb2RpZmllZE9uIjoiMjAyMi0wNC0yOCAyMTo1NDo1MSJ9", "createdOn": "2024-06-07T13:23:34.204Z", "modifiedOn": "2024-06-07T13:23:34.204Z" } ]
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>/searchassistapi/external/stream/<stream-id>/connector/<connector-id>/permission_entities/<entity-id> |
| Content-Type | application/json |
| Authorization | auth: <JWT Token> |
| API Scope | user_association |
Query Parameters
| Parameters | Description | Mandatory |
| Stream ID | Provide your application ID here. | Yes |
| Entity Id | Unique Id of the Permission Entity | Yes |
Sample Response
{ "_id": "fpe-1e964f98-68cf-5b5e-802d-0f4c88577c52", "searchIndexId": "sidx-1a03bc64-a17c-59f7-ba81-6a9be27a08db", "entity": "fd8f94c3b58b8110f8779c9460b514ce", "userIds": [ "sample-user1@kore.com" ], "blocklist": [], "whitelist": [], "meta": {}, "SHA": "eyJtb2RpZmllZE9uIjoiMjAyMi0wNC0yOCAyMTo1NDo1MSJ9", "createdOn": "2024-06-07T13:23:34.204Z", "modifiedOn": "2024-06-07T13:23:34.204Z" }
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>/searchassistapi/external/stream/<stream-id>/connector/<connector-id>/permission_entities/<entity-id> |
| Content-Type | application/json |
| Authorization | auth: <JWT Token> |
| API Scope | user_association |
Query Parameters
<tdUnique Id of the Permission Entity Yes
| Parameters | Description | Mandatory |
| Stream ID | Provide your application ID here. | Yes |
| Entity Id |
Sample Request Body
To associate a user with a permission entity, use the following as the request body. { "userIds": [ "john@kore.com" ] }
Delete Users Permission Entity by ID
This API is used to remove a user already associated with the permission entity.
| Method | DELETE |
| Endpoint | <host_url>/searchassistapi/external/stream/<stream-id>/connector/<connector-id>/permission_entities/<entity-id> |
| Content-Type | application/json |
| Authorization | auth: <JWT Token> |
| API Scope | user_association |
Query Parameters
| Parameters | Description | Mandatory |
| Stream ID | Provide your application ID here. | 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.
{ "userIds": [ "john@kore.com" ] }