1Get Folder Access Rights
Overview
This API retrieves the Access Rights of the specified folder.
Method: GET
Request URL: {kyvos-url}/rest/v2/share/folder/{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 | Name or ID of the folder whose Access Rights 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 folder name or folder ID. If by=name, provide the folder name in the name-or-id parameter. If by=id, provide the folder ID in the name-or-id parameter. The default value is name. | – |
type (Required) | String | Entity type of the folder whose Access Rights need to be retrieved. |
|
Responses
200 Success
{
"accessrights": {
"groups": [
{
"name": "admin",
"id": "17816948496913127037055138895760",
"grant": "Read And Write"
}
],
"users": [
{
"name": "kyvos",
"id": "351003706",
"grant": "Read Only"
}
]
}
}Status Code | Description |
|---|---|
401 | Authorization information is missing or invalid. |
404 | Connection, database, schema, or table not found. |
412 | Precondition failed. Parameter missing. |
500 | Internal Server Error |