1Update User
Overview
This API updates an existing user in the system using the details provided.
Method: PUT
Request URL: {kyvos-url}/rest/v2/users/{name-or-id}
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. | – |
Path Parameters
Parameter Name | Type | Description | Possible Values |
|---|---|---|---|
name-or-id (Required) | String | Name or ID of the User to be updated. | – |
Query Parameters
Parameter Name | Type | Description | Possible Values |
|---|---|---|---|
by | String | Specifies whether the name-or-id parameter should be interpreted as a User name or User ID. If by=name, provide the User name in the name-or-id parameter. If by=id, provide the User ID in the name-or-id parameter. The default value is name. | – |
Request Body
Parameter Name | Type | Description | Possible Values |
|---|---|---|---|
json (Required) | String | A JSON object containing the updated details for the specified user. Note: An example JSON is provided under the Resources section below. | – |
Responses
200 Success
{
"code": 0,
"message": "Successfully updated user: Admin"
}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 json parameter in the request body.
{
"id": "97795239",
"name": "kyvos.user",
"email": "new@example.com",
"password": "newPassword123",
"description": "This is a sample user",
"groupIds": "",
"roles": "1",
"userStatus": 0,
"userCustomAttributes": []
}
JSON Fields Description:
Field | Type | Description | Possible Values | Example |
|---|---|---|---|---|
| String | Username. Must match the | Any valid username string |
|
| String | Updated description for the user. | Any string or |
|
| String | Updated value for role assignment. |
|
|
| String | Comma-separated group IDs to assign the user to. | Any valid group ID(s) or |
|
| Integer | Updated account status. |
|
|
| Array | Replaced set of custom attribute objects for the user. |
|
|
| String | Updated email address. | Valid email or |
|
| String | Updated password. Only applicable when | Any string |
|
| String | Updated authentication type. |
|
|