1Remove Entity Access Rights

1Remove Entity Access Rights

Overview

This API removes Access Rights assigned to an entity.

Method: DELETE

Request URL: {kyvos-url}/rest/v2/share/entity/{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

Header Name

Type

Description

Possible Values

Content-Type (Required)

String

Specifies media type of request body.

application/x-www-form-urlencoded

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

Parameter Name

Type

Description

Possible Values

name-or-id (Required)

String

Name or ID of the entity whose Access Rights need to be removed.

–


Query Parameters

Parameter Name

Type

Description

Possible Values

Parameter Name

Type

Description

Possible Values

by

String

Specifies whether the name-or-id parameter should be interpreted as an entity name or entity ID.

If by=name, provide the entity name in the name-or-id parameter.

If by=id, provide the entity ID in the name-or-id parameter.

The default value is name.

–


Request Body

Parameter Name

Type

Description

Possible Values

Parameter Name

Type

Description

Possible Values

type (Required)

String

Type of entity whose Access Rights need to be removed.

RDATASET, RELATIONSHIP, SMODEL, CONNECTION, SPACE, WORKSHEET, WORKBOOK

folderName

String

Name of the folder that contains the entity. If the entity is present in the root directory, specify [Root].

Note: If neither folderName nor folderId is provided, the entity will be treated as a root-level entity by default.

–

folderId

String

ID of the folder that contains the entity.

–

assigneeName

String

Name of the user or group whose Access Rights need to be removed.

–

assigneeType

String

The type of assignee whose Access Rights need to be removed.

USER, GROUP

grant

String

The type of access permission to be removed.

READ_ONLY, READ_WRITE, DENY

workbookName

String

Name of the Workbook containing the Worksheet.

Note: Either workbookName or workbookId is required when type=WORKSHEET and Worksheet name is provided in the name-or-id path parameter.

–

workbookId

String

ID of the Workbook containing the Worksheet.

–


Responses

200 Success

{ "code": 0, "message": "Entity access rights deleted successfully." }

Status Code

Description

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

Copyright Kyvos, Inc. 2026. All rights reserved.