Skip to content
/
Add user group members

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

Get user group members

Request

Retrieve the user group members

Security
OAuth2ClientCredentials
Path
user_group_idstring(uuid)required

User group ID

Query
page_tokenstring

Token for getting the previous/next page

page_sizeinteger>= 1required

The number of results to retrieve per page

search_querystringnon-empty

Username or email address search query (partial match)

curl -i -X GET \
  'https://{api_base_url_without_scheme}/rest/v1/user-groups/{user_group_id}/users?page_token=string&page_size=1&search_query=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json
user_idsArray of strings(uuid)required

List of user group member user IDs

next_page_tokenstring

Token to get the next page (omitted if page does not exist)

prev_page_tokenstring

Token to get the prev page (omitted if page does not exist)

total_sizeinteger>= 0required

Total number of matches for the search criteria

Response
application/json
{
  "user_ids": [
    "76088fa5-1ce5-3ca9-303a-8466c48581ba",
    "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  ],
  "total_size": 150,
  "next_page_token": "eyJvZmZz...",
  "prev_page_token": "eyJvZmZz..."
}

Add user group members

Request

Add user group members to the user group

Security
OAuth2ClientCredentials
Path
user_group_idstring(uuid)required

User group ID

Bodyapplication/jsonrequired

User group member add request

user_group_member_idsArray of strings(uuid)non-emptyrequired

Array of user group member user IDs

curl -i -X POST \
  'https://{api_base_url_without_scheme}/rest/v1/user-groups/{user_group_id}/users' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "user_group_member_ids": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ]
  }'

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
}

Remove user group members

Request

Remove user group members from the user group

Security
OAuth2ClientCredentials
Path
user_group_idstring(uuid)required

User group ID

Bodyapplication/jsonrequired

User group member remove request

user_group_member_idsArray of strings(uuid)non-emptyrequired

Array of user group member user IDs

curl -i -X DELETE \
  'https://{api_base_url_without_scheme}/rest/v1/user-groups/{user_group_id}/users' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "user_group_member_ids": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ]
  }'

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