1Get Group
Overview
This API retrieves details of a specific Group using its name or ID.
Method: GET
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 |
|---|---|---|---|
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 | The name or ID of the Group whose details need to be retrieved. | – |
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. | – |
Responses
200 Success
{
"groupType": "NATIVE",
"roles": "",
"userIds": "",
"name": "Kyvos",
"description": "",
"id": "1256GF43-0CE6-CA3B-94D9-BABD1C787505",
"provisionedBy": ""
}Status Code | Description |
|---|---|
401 | Authorization information is missing or invalid. |
404 | No matching record found. |
500 | Internal Server Error |