1Share Folder
Overview
This API shares a folder with the specified user or group.
Method: POST
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 |
|---|---|---|---|
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 folder that needs to be shared. | – |
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. | – |
Request Body
Parameter Name | Type | Description | Possible Values |
|---|---|---|---|
type (Required) | String | Entity type of the folder to be shared. |
|
assigneeName | String | Name of the user or group with whom the folder needs to be shared. | – |
assigneeType | String | Type of assignee with whom the folder needs to be shared. |
|
grant | String | Type of access permission which needs to be assigned. |
|
Responses
200 Success
{
"code": 0,
"message": "Folder shared successfully."
}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 |