Written by

Get entries, workbooks and collections permissions

Returns permissions for the specified DataLens entries, workbooks and collections.

Request

POST

https://api.datalens.tech/rpc/getPermissionsBulk

Headers

Name

Description

x-dl-api-version

Type: string

API version header.

Const: 2

Example: 2

Body

application/json

{
  "entryIds": [
    "example"
  ],
  "workbookIds": [
    "example"
  ],
  "collectionIds": [
    "example"
  ]
}

Name	Description
collectionIds	Type: string[] Identifiers of the collections to check permissions for. Min items: `1` Max items: `1000` Example `[ "example" ]`
entryIds	Type: string[] Identifiers of the entries to check permissions for. Min items: `1` Max items: `1000` Example `[ "example" ]`
workbookIds	Type: string[] Identifiers of the workbooks to check permissions for. Min items: `1` Max items: `1000` Example `[ "example" ]`

Responses

200 OK

Response

Body

application/json

{
  "entries": {},
  "workbooks": {},
  "collections": {}
}

Name

Description

collections

Type: object

[additional]

Any of 2 types

Type: object

permissions

Type: object

copy	Type: boolean Indicates if the collection can be copied.
createCollection	Type: boolean Indicates if child collections can be created in the collection.
createSharedEntry	Type: boolean Indicates if shared entries can be created in the collection.
createWorkbook	Type: boolean Indicates if workbooks can be created in the collection.
delete	Type: boolean Indicates if the collection can be deleted.
limitedView	Type: boolean Indicates if the collection can be viewed with limited access.
listAccessBindings	Type: boolean Indicates if access bindings for the collection can be listed.
move	Type: boolean Indicates if the collection can be moved.
update	Type: boolean Indicates if the collection can be updated.
updateAccessBindings	Type: boolean Indicates if access bindings for the collection can be updated.
view	Type: boolean Indicates if the collection can be viewed.

Permissions for the collection.

Example

{
  "listAccessBindings": true,
  "updateAccessBindings": true,
  "createSharedEntry": true,
  "createCollection": true,
  "createWorkbook": true,
  "limitedView": true,
  "view": true,
  "update": true,
  "copy": true,
  "move": true,
  "delete": true
}

Example

{
  "permissions": {
    "listAccessBindings": true,
    "updateAccessBindings": true,
    "createSharedEntry": true,
    "createCollection": true,
    "createWorkbook": true,
    "limitedView": true,
    "view": true,
    "update": true,
    "copy": true,
    "move": true,
    "delete": true
  }
}

Type: object

error

Type: string

Error code indicating a missing resource.

Const: NOT_FOUND

Example: example
Example
```
{
  "error": "NOT_FOUND"
}
```

Example

{
  "permissions": {
    "listAccessBindings": true,
    "updateAccessBindings": true,
    "createSharedEntry": true,
    "createCollection": true,
    "createWorkbook": true,
    "limitedView": true,
    "view": true,
    "update": true,
    "copy": true,
    "move": true,
    "delete": true
  }
}

Collection permissions or errors indexed by collection ID.

Example

{}

entries

Type: object

[additional]

Any of 2 types

Type: object

fullPermissions

Type: object

copy	Type: boolean Permission to copy.
createEntryBinding	Type: boolean Permission to create entry binding.
createLimitedEntryBinding	Type: boolean Permission to create limited entry binding.
delete	Type: boolean Permission to delete.
limitedView	Type: boolean Permission for limited viewing.
listAccessBindings	Type: boolean Permission to list access bindings.
move	Type: boolean Permission to move.
update	Type: boolean Permission to update.
updateAccessBindings	Type: boolean Permission to update access bindings.
view	Type: boolean Permission to view.

Full permissions for the entry.

Example

{
  "listAccessBindings": true,
  "updateAccessBindings": true,
  "limitedView": true,
  "view": true,
  "update": true,
  "copy": true,
  "move": true,
  "delete": true,
  "createEntryBinding": true,
  "createLimitedEntryBinding": true
}

permissions

Type: object

admin	Type: boolean Indicates if there are permissions for admin.
edit	Type: boolean Indicates if there are permissions to edit.
execute	Type: boolean Indicates if there are permissions to execute.
read	Type: boolean Indicates if there are permissions to read.

Basic permissions for the entry.

Example

{
  "execute": true,
  "read": true,
  "edit": true,
  "admin": true
}

Example

{
  "permissions": {
    "execute": true,
    "read": true,
    "edit": true,
    "admin": true
  },
  "fullPermissions": {
    "listAccessBindings": true,
    "updateAccessBindings": true,
    "limitedView": true,
    "view": true,
    "update": true,
    "copy": true,
    "move": true,
    "delete": true,
    "createEntryBinding": true,
    "createLimitedEntryBinding": true
  }
}

Type: object

error

Type: string

Error code indicating a missing resource.

Const: NOT_FOUND

Example: example
Example
```
{
  "error": "NOT_FOUND"
}
```

Example

{
  "permissions": {
    "execute": true,
    "read": true,
    "edit": true,
    "admin": true
  },
  "fullPermissions": {
    "listAccessBindings": true,
    "updateAccessBindings": true,
    "limitedView": true,
    "view": true,
    "update": true,
    "copy": true,
    "move": true,
    "delete": true,
    "createEntryBinding": true,
    "createLimitedEntryBinding": true
  }
}

Entry permissions or errors indexed by entry ID.

Example

{}

workbooks

Type: object

[additional]

Any of 2 types

Type: object

permissions

Type: object

copy	Type: boolean Indicates if the workbook can be copied.
delete	Type: boolean Indicates if the workbook can be deleted.
embed	Type: boolean Indicates if entries in the workbook can be embedded.
limitedView	Type: boolean Indicates if the workbook can be viewed with limited access.
listAccessBindings	Type: boolean Indicates if access bindings for the workbook can be listed.
move	Type: boolean Indicates if the workbook can be moved.
publish	Type: boolean Indicates if entries in the workbook can be published.
update	Type: boolean Indicates if the workbook can be updated.
updateAccessBindings	Type: boolean Indicates if access bindings for the workbook can be updated.
view	Type: boolean Indicates if the workbook can be viewed.

Permissions for the workbook.

Example

{
  "listAccessBindings": true,
  "updateAccessBindings": true,
  "limitedView": true,
  "view": true,
  "update": true,
  "copy": true,
  "move": true,
  "publish": true,
  "embed": true,
  "delete": true
}

Example

{
  "permissions": {
    "listAccessBindings": true,
    "updateAccessBindings": true,
    "limitedView": true,
    "view": true,
    "update": true,
    "copy": true,
    "move": true,
    "publish": true,
    "embed": true,
    "delete": true
  }
}

Type: object

error

Type: string

Error code indicating a missing resource.

Const: NOT_FOUND

Example: example
Example
```
{
  "error": "NOT_FOUND"
}
```

Example

{
  "permissions": {
    "listAccessBindings": true,
    "updateAccessBindings": true,
    "limitedView": true,
    "view": true,
    "update": true,
    "copy": true,
    "move": true,
    "publish": true,
    "embed": true,
    "delete": true
  }
}

Workbook permissions or errors indexed by workbook ID.

Example

{}

Get entries, workbooks and collections permissions

RequestRequest

HeadersHeaders

BodyBody

ResponsesResponses

200 OK200 OK

BodyBody

Was the article helpful?

Request

Headers

Body

Responses

200 OK

Body