Skip to content

workspaces_access_check_create

POST
/api/workspaces/{id}/access-check
curl --request POST \
--url https://example.com/api/workspaces/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/access-check \
--header 'Authorization: Bearer <token>'

Check again the access of the user to all the data they see in a workspace.

Every source is queried, which may take long: while a check of the user is under way, no other one is started. Its end is announced by the websocket message update_data_access.

id
required
string format: uuid

A UUID string identifying this workspace.

Media typeapplication/json

The answer to a request for a check of the access of the user.

object
started
required

False when a check was already under way: none is added.

boolean
check_in_progress
required
boolean

Example generated

{
"started": true,
"check_in_progress": true
}
Media typeapplication/json
object
code
required
string
>= 1 characters
message
required
string
>= 1 characters
details
required
Array<object>
object
parameter
string
nullable
code
string
nullable
message
string

Example

{
"code": "forbidden",
"message": "You do not have permission to perform this operation. Check the `details` property for more details.",
"details": [
{
"parameter": "workspace",
"code": "not_allowed",
"message": "You are not a member of this workspace."
}
]
}
Media typeapplication/json
object
code
required
string
>= 1 characters
message
required
string
>= 1 characters
details
required
Array<object>
object
parameter
string
nullable
code
string
nullable
message
string

Example

{
"code": "object_not_found",
"message": "Object not found. Check the `details` property for more details.",
"details": [
{
"parameter": "<id>",
"code": "does_not_exist",
"message": "\"<id>\" does not exist."
}
]
}