Skip to content
/
Update access controls

LegalOn API (0.9.0)

API documentation for LegalOn services

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

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.

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

Responses

No Content

Response
No content

Departments

Operations about department

Operations