Create Group
This documentation is for Kyvos 2026.8.x. To view documentation for other Kyvos versions, click here. |
|---|
Overview
This API creates a new Group using the details provided.
Method: POST
Request URL: {kyvos-url}/rest/v2/groups
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. | – |
Request Body
Parameter Name | Type | Description | Possible Values |
|---|---|---|---|
json (Required) | String | JSON object containing the details of the Group to be created. Note: An example JSON is provided under the Resources section below. | – |
Responses
200 Success
{
"code": 0,
"message": "Successfully added group: Kyvos"
}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.
{
"groupType": "NATIVE",
"roles": "0",
"userIds": "84903421, 84903523",
"name": "Sample Group",
"description": "This is a sample group."
} JSON Fields Description:
Field | Type | Description | Possible Values | Example |
|---|---|---|---|---|
| String | Name of the Group. | Any valid string |
|
| String | Optional description or note about the Group. | Any string |
|
| String | Comma-separated role name(s) or role ID(s) to assign to the Group. All the Users assigned to this group will follow this role. |
|
|
| String | Comma-separated User ID(s) to assign to the Group. | Any valid User ID(s) |
|
| String | Type of the Group in Kyvos. |
|
|