Skip to content
/
Get access controls

LegalOn API (1.0.0)

API documentation for LegalOn services

Languages
Servers
The server URL is `{api_base_url}/rest/v1`. You can construct the server URL using the value of `api_base_url` provided in the response when obtaining an access token.
https://{api_base_url_without_scheme}/rest/v1

Users

Operations about user

Operations

User Groups

Operations about user group

Operations

Workspaces

Operations about workspace/folder

Operations

Move workspace/folder

Request

Move the workspace/folder

Security
OAuth2ClientCredentials
Path
space_idstring(uuid)required

Workspace/folder ID

Bodyapplication/jsonrequired

Workspace/folder move request

destination_parent_space_idstring(uuid)

Destination parent workspace/folder Id. Moves to the workspace/folder immediately below the specified workspace/folder. If not specified, moves to the top level.

curl -i -X POST \
  'https://{api_base_url_without_scheme}/rest/v1/spaces/{space_id}:move' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "destination_parent_space_id": "c4d4533c-f6ad-40be-abc3-92fd8c58ceae"
  }'

Responses

No Content

Response
No content

Get access controls

Request

Retrieve the access controls

Security
OAuth2ClientCredentials
Path
space_idstring(uuid)required

Workspace/folder ID

Query
search_querystringnon-empty

A search string, which can be a user name, user group name, or email address.

curl -i -X GET \
  'https://{api_base_url_without_scheme}/rest/v1/spaces/{space_id}/acls?search_query=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json
space_idstring(uuid)required

Workspace/folder ID

is_inheritedbooleanrequired

Whether the access control is inherited from a higher level

user_group_access_levelArray of objects(user_group_access_level)
user_access_levelArray of objects(user_access_level)
user_group_total_sizeinteger>= 0

The total number of user groups that match the search criteria

user_total_sizeinteger>= 0

The total number of users that match the search criteria

Response
application/json
{
  "space_id": "76088fa5-1ce5-3ca9-303a-8466c48581ba",
  "is_inherited": false,
  "user_group_access_level": [
    { … },
    { … }
  ],
  "user_access_level": [
    { … }
  ],
  "user_group_total_size": 2,
  "user_total_size": 1
}

Update access controls

Request

Update the access controls

Security
OAuth2ClientCredentials
Path
space_idstring(uuid)required

Workspace/folder ID

Bodyapplication/jsonrequired

Access controls update request

access_controlsArray of objects(access_control)required
access_controls[].​principal_idstring(uuid)required

principal id

access_controls[].​principal_typestringrequired

Principal type USER:user USER_GROUP:user group

Enum"USER""USER_GROUP"
access_controls[].​access_levelstringrequired

access level MANAGER:manager EDITOR:editor POSTER:poster VIEWER:viewer NONE:none

Enum"MANAGER""EDITOR""POSTER""VIEWER""NONE"
is_inheritedboolean

Whether the access control is inherited from a higher level

curl -i -X PATCH \
  'https://{api_base_url_without_scheme}/rest/v1/spaces/{space_id}/acls' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "access_controls": [
      {
        "principal_id": "b0fe3bdd-8201-445a-aab3-a018692d6aca",
        "principal_type": "USER",
        "access_level": "MANAGER"
      }
    ],
    "is_inherited": true
  }'

Responses

No Content

Response
No content

Departments

Operations about department

Operations