1Update Kyvos Dialogs User Access
Overview
This API updates users' access to Kyvos Dialogs.
Method: POST
Request URL: {kyvos-url}/rest/v2/users/kyvos-dialogs-users
Authorization
API Key: sessionid
This method authenticates requests using a session ID which acts like an API key.
BasicAuth: HTTP Authorization Scheme
This method authenticates requests using a username and password sent in the HTTP Authorization header.
Headers
Header Name | Type | Description | Possible Values |
|---|---|---|---|
Content-Type (Required) | String | Specifies the media type of the request body. |
|
sessionid | String | The session ID is the token received from the login API. Note: Session ID is required for token-based authentication. | – |
Request Body
Parameter Name | Type | Description | Possible Values |
|---|---|---|---|
userDetailsJson (Required) | String | List of users whose access to Kyvos Dialogs needs to be updated. Note: An example JSON is provided under the Resources section below. | – |
action | String | Specifies the operation to perform on the Kyvos Dialogs user configuration. |
|
Responses
200 Success
{
"code": 0,
"updatedUsersList": [
"biuser"
],
"message": "",
"failedUsersList": []
}Status Code | Description |
|---|---|
401 | Authorization information is missing or invalid. |
404 | Connection, database, schema, or table not found. |
412 | Precondition failed. Required parameter missing. |
500 | Internal Server Error |
Resources
Below is an example of JSON structure which can be used as a reference for the userDetailsJson parameter in the request body.
[
{
"name": "BI User",
"id": "322598657"
}
]Description for userDetailsJson parameter
Name: Name of the user.
id: ID of the user.