Skip to content
/
ユーザーグループを作成

LegalOn API (1.0.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
Query
limit_sizeinteger>= 1required

取得する最大件数

search_querystringnon-empty

検索クエリ文字列(ユーザーグループ名の部分一致検索)

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

Responses

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

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

ユーザーグループを作成

Request

新しいユーザーグループを作成します

Security
OAuth2ClientCredentials
Bodyapplication/jsonrequired

ユーザーグループ作成リクエスト

display_namestring[ 1 .. 100 ] charactersrequired

ユーザーグループ名

descriptionstring[ 0 .. 100 ] characters

ユーザーグループの説明

curl -i -X POST \
  'https://{api_base_url_without_scheme}/rest/v1/user-groups' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "display_name": "string",
    "description": "string"
  }'

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

Bodyapplication/jsonrequired

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

display_namestring[ 1 .. 100 ] charactersrequired

ユーザーグループ名

descriptionstring[ 0 .. 100 ] characters

ユーザーグループの説明

curl -i -X PATCH \
  'https://{api_base_url_without_scheme}/rest/v1/user-groups/{user_group_id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "display_name": "string",
    "description": "string"
  }'

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
}

ワークスペース

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

Operations

部署

部署に関する操作

Operations