Skip to content
/
Create user group

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

List user groups

Request

Retrieve a list of user groups

Security
OAuth2ClientCredentials
Query
limit_sizeinteger>= 1required

Maximum number of result to retrieve

search_querystringnon-empty

Search query string (partial match search for user group name)

Responses

OK

Bodyapplication/json
user_groupsArray of objects(user-group)
Response
application/json
{
  "user-groups": [
    { … }
  ]
}

Create user group

Request

Create a new user group

Security
OAuth2ClientCredentials
Bodyapplication/jsonrequired

User group creation request

display_namestring[ 1 .. 100 ] charactersrequired

User group name

descriptionstring[ 0 .. 100 ] characters

User group description

Responses

Created

Bodyapplication/json
user_group_idstring(uuid)required

User Group Id

display_namestring[ 1 .. 100 ] charactersrequired

User Group name

descriptionstring[ 0 .. 100 ] characters

User Group description

member_sizeintegerrequired

User Group member size

Response
application/json
{
  "user_group_id": "76088fa5-1ce5-3ca9-303a-8466c48581ba",
  "display_name": "Legal Department",
  "description": "Contract Review Members",
  "member_size": 2
}

Update user group

Request

Update the user group

Security
OAuth2ClientCredentials
Path
user_group_idstring(uuid)required

User group ID

Bodyapplication/jsonrequired

User group update request

display_namestring[ 1 .. 100 ] charactersrequired

User group name

descriptionstring[ 0 .. 100 ] characters

User group description

Responses

OK

Bodyapplication/json
user_group_idstring(uuid)required

User Group Id

display_namestring[ 1 .. 100 ] charactersrequired

User Group name

descriptionstring[ 0 .. 100 ] characters

User Group description

member_sizeintegerrequired

User Group member size

Response
application/json
{
  "user_group_id": "76088fa5-1ce5-3ca9-303a-8466c48581ba",
  "display_name": "Legal Department",
  "description": "Contract Review Members",
  "member_size": 2
}

Workspaces

Operations about workspace/folder

Operations

Departments

Operations about department

Operations