Skip to content
/
ユーザーグループにメンバーを追加

LegalOn API (1.1.0)

API documentation for LegalOn services

Languages
Servers
サーバーのURLは `{api_base_url}/rest/v1` です。 アクセストークン取得時のレスポンスに含まれる `api_base_url` の値を用いてサーバーの URL を構成してください。
https://{api_base_url_without_scheme}/rest/v1

ユーザー

ユーザーに関する操作

Operations

ユーザーグループ

ユーザーグループに関する操作

Operations

ユーザーグループメンバー一覧を取得

Request

ユーザーグループメンバー一覧を取得します

Security
OAuth2ClientCredentials
Path
user_group_idstring(uuid)required

LegalOnが生成したユーザーグループID

Query
page_sizeinteger>= 1required

1ページあたりの取得件数

search_querystringnon-empty

指定した文字列がユーザー名またはメールアドレスと部分一致した場合にレスポンスが返ります。 ユーザー名またはメールアドレスのいずれかのみを検索対象として指定することはできません。

page_tokenstring

前/次ページ取得用トークン

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

Responses

正常にユーザーグループメンバー一覧を取得

Bodyapplication/json
user_idsArray of strings(uuid)required

ユーザーグループメンバーの、LegalOnが生成したユーザーIDのリスト

next_page_tokenstring

次のページを取得するトークン（ページが存在しない場合は省略）

prev_page_tokenstring

前のページを取得するトークン（ページが存在しない場合は省略）

total_sizeinteger>= 0required

検索条件に一致する、ACTIVE、INACTIVEおよびINVITEDステータスのユーザーの総数

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..."
}

ユーザーグループにメンバーを追加

Request

ユーザーグループにメンバーを追加します。 指定したユーザーが既にユーザーグループに所属している場合、何も変更せずエラーにもなりません。 ユーザーグループに所属できるユーザー数に上限はありません。 1回のリクエストで追加できるユーザー数は100件までです。

Security
OAuth2ClientCredentials
Path
user_group_idstring(uuid)required

LegalOnが生成したユーザーグループID

Bodyapplication/jsonrequired

ユーザーグループメンバー追加リクエスト

user_group_member_idsArray of strings(uuid)non-emptyrequired

LegalOnが生成したユーザーID。 ユーザーステータスがACTIVEまたはINVITEDのユーザーは追加できます。 INACTIVEのユーザーは追加できず、エラーになります。

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

正常にユーザーグループメンバーを追加

Bodyapplication/json
user_group_idstring(uuid)required

LegalOnが生成したユーザーグループID

display_namestring[ 1 .. 100 ] charactersrequired

ユーザーグループ名。全角文字と半角文字はいずれも1文字としてカウントします。

descriptionstring[ 0 .. 100 ] characters

ユーザーグループの説明。全角文字と半角文字はいずれも1文字としてカウントします。

member_sizeintegerrequired

グループに含まれるACTIVE、INACTIVEおよびINVITEDステータスのユーザー数

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

ユーザーグループからメンバーを削除

Request

ユーザーグループからメンバーを削除します。 1回のリクエストで削除できるユーザー数は100件までです。

Security
OAuth2ClientCredentials
Path
user_group_idstring(uuid)required

LegalOnが生成したユーザーグループID

Bodyapplication/jsonrequired

ユーザーグループメンバー削除リクエスト

user_group_member_idsArray of strings(uuid)non-emptyrequired

LegalOnが生成したユーザーID。 ユーザーステータスがACTIVE、INACTIVEまたはINVITEDのユーザーは削除できます。

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

正常にユーザーグループメンバーを削除

Bodyapplication/json
user_group_idstring(uuid)required

LegalOnが生成したユーザーグループID

display_namestring[ 1 .. 100 ] charactersrequired

ユーザーグループ名。全角文字と半角文字はいずれも1文字としてカウントします。

descriptionstring[ 0 .. 100 ] characters

ユーザーグループの説明。全角文字と半角文字はいずれも1文字としてカウントします。

member_sizeintegerrequired

グループに含まれるACTIVE、INACTIVEおよびINVITEDステータスのユーザー数

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

ワークスペース

ユーザーの閲覧権限によらず、テナント内のすべてのワークスペース/フォルダに関する操作

Operations

部署

部署に関する操作

Operations

契約書（ファイル）

契約書の作成・取得・更新・削除などの操作を提供します。ワークスペースを対象とする操作では、共通の「ワークスペース」（GET /workspaces）で取得した workspace_id を指定してください。

Operations

ワークスペース

共通のワークスペース/フォルダは、契約書などのリソースを格納・整理する単位です。本エンドポイントは、APIを呼び出すユーザーがアクセス権を持つワークスペース/フォルダをツリー構造で返します。契約書APIなどワークスペースを対象とする操作では、ここで取得した workspace_id を指定してください。テナント内全体の管理（作成・権限設定など）は管理者設定のワークスペース操作（/spaces）を参照してください。

Operations