Skip to content
/
ユーザーグループを削除

LegalOn API (0.9.0)

API documentation for LegalOn services

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

ユーザーグループID

Bodyapplication/jsonrequired

ユーザーグループ更新リクエスト

display_namestring[ 1 .. 100 ] charactersrequired

ユーザーグループ名

descriptionstring[ 0 .. 100 ] characters

ユーザーグループの説明

Responses

正常にユーザーグループを更新

Bodyapplication/json
user_group_idstring(uuid)required

ユーザーグループID

display_namestring[ 1 .. 100 ] charactersrequired

ユーザーグループ名

descriptionstring[ 0 .. 100 ] characters

ユーザーグループの説明

member_sizeintegerrequired

グループメンバー数

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

ユーザーグループを削除

Request

ユーザーグループを削除します

Security
OAuth2ClientCredentials
Path
user_group_idstring(uuid)required

ユーザーグループID

Responses

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

Response
No content

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

Request

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

Security
OAuth2ClientCredentials
Path
user_group_idstring(uuid)required

ユーザーグループID

Query
page_tokenstring

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

page_sizeinteger>= 1required

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

search_querystringnon-empty

ユーザー名またはメールアドレスの検索クエリ（部分一致）

Responses

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

Bodyapplication/json
user_idsArray of strings(uuid)required

ユーザーグループメンバーのユーザーIDのリスト

next_page_tokenstring

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

prev_page_tokenstring

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

total_sizeinteger>= 0required

検索条件に一致する総数

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

ワークスペース

ワークスペース/フォルダに関する操作

Operations

部署

部署に関する操作

Operations