1Update Group
Overview
This API updates an existing Group using the details provided.
Method: PUT
Request URL: {kyvos-url}/rest/v2/groups/{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 media type of 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 Group that needs 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 Group name or Group ID. If by=name, provide the Group name in the name-or-id parameter. If by=id, provide the Group ID in the name-or-id parameter. The default value is name. | – |
Request Body
Parameter Name | Type | Description | Possible Values |
|---|---|---|---|
json (Required) | String | JSON object containing details of the Group to be updated. Note: An example JSON is provided under the Resources section below. | – |
Responses
200 Success
{
"code": 0,
"message": "Group updated successfully."
}Status Code | Description |
|---|---|
401 | Authorization information is missing or invalid. |
404 | No matching record 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.
{
"name": "updated group",
"description": "This is a sample group with updated name.",
"id": "17816914172543127074019131780368",
"roles": "3",
"userIds": "17816912679113127074068120525290,84903421,84903523"
}JSON Fields Description:
Field | Type | Description | Possible Values | Example |
|---|---|---|---|---|
| String | Updated name of the Group. | Any valid string |
|
| String | Updated description or note about the Group. | Any string |
|
| String | Updated comma-separated role name(s) or role ID(s) to assign to the Group. |
|
|
| String | Updated comma-separated User ID(s) to assign to the Group. | Any valid User ID(s) |
|