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

ユーザー一覧を取得

Request

ユーザーの一覧を取得します

Security
OAuth2ClientCredentials
Query
page_tokenstring

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

page_sizeinteger>= 1required

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

search_querystringnon-empty

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

user_statusesArray of strings

フィルタするユーザーステータス（複数指定時はOR条件）

Items Enum"INVITED""ACTIVE""INACTIVE"
roleArray of strings

フィルタするロール（複数指定時はOR条件）

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

Responses

正常にユーザー一覧を取得

Bodyapplication/json
usersArray of objects(user)required
users[].​user_idstring(uuid)required

ユーザーID

users[].​emailstring(email)required

メールアドレス

users[].​user_statusstringrequired

ユーザーステータス

Enum"INVITED""ACTIVE""INACTIVE"
users[].​display_namestring[ 1 .. 48 ] charactersrequired

ユーザー名

users[].​profile_image_urlstring(uri)

プロフィール画像URL

users[].​user_rolesArray of stringsrequired

ユーザーに付与するロール リージョンごとに利用可能なロールが異なります

JP リージョン

  • ItAdmin (IT管理者)
  • MatterManagementPro (マターマネジメント: プロ)
  • MatterManagementStandard (マターマネジメント: スタンダード)
  • MatterManagementAdmin (マターマネジメント: 管理者)
  • ReviewStandard (レビュー: スタンダード)
  • ReviewStandardPlaybook (レビュー: スタンダード(プレイブック))
  • ReviewPro (レビュー: プロ)
  • ReviewBasicPlaybook (レビュー: ベーシック(プレイブック))
  • ReviewAdmin (レビュー: 管理者)
  • SignUser (サイン: 利用する)
  • SignAdmin (サイン: 管理者)
  • ContractManagementAdmin (コントラクトマネジメント: 管理者)
  • LegalonTemplatePro (Legalonテンプレート: プロ)
  • LegalonTemplateAdmin (Legalonテンプレート: 管理者)
  • MoriHamadaLibraryPro (MORI HAMADAライブラリー: プロ)
  • MoriHamadaLibraryAdmin (MORI HAMADAライブラリー: 管理者)
  • UniversalAssistStandard (ユニバーサルアシスト: スタンダード)
  • UniversalAssistAdmin (ユニバーサルアシスト: 管理者)
  • LegalonAssistantPro (Legalonアシスタント: プロ)
  • LegalonAssistantStandard (Legalonアシスタント: スタンダード)
  • LegalonAssistantAdmin (Legalonアシスタント: 管理者)

US リージョン

  • ItAdmin (IT管理者)
  • USMatterManagementPro (マターマネジメント: プロ)
  • MatterManagementStandard (マターマネジメント: スタンダード)
  • MatterManagementAdmin (マターマネジメント: 管理者)
  • USReviewPro (レビュー: プロ)
  • USReviewAdmin (レビュー: 管理者)
  • ContractManagementAdmin (コントラクトマネジメント: 管理者)
  • USLegalonAssistantPro (Legalonアシスタント: プロ)
  • LegalonAssistantStandard (Legalonアシスタント: スタンダード)
  • LegalonAssistantAdmin (Legalonアシスタント: 管理者)
  • TranslationPro (翻訳: プロ)
  • TranslationAdmin (翻訳: 管理者)
next_page_tokenstring

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

prev_page_tokenstring

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

total_sizeinteger>= 0required

検索条件に一致する総数

Response
application/json
{
  "users": [
    { … }
  ],
  "total_size": 150,
  "next_page_token": "eyJvZmZz...",
  "prev_page_token": "eyJvZmZz..."
}

ユーザーを作成

Request

新しいユーザーを作成します

Security
OAuth2ClientCredentials
Bodyapplication/jsonrequired

ユーザー作成リクエスト

display_namestring[ 1 .. 48 ] charactersrequired

ユーザー名

emailstring(email)required

メールアドレス

user_rolesArray of stringsrequired

ユーザーに付与するロール

curl -i -X POST \
  'https://{api_base_url_without_scheme}/rest/v1/users' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "display_name": "string",
    "email": "user@example.com",
    "user_roles": [
      "string"
    ]
  }'

Responses

正常にユーザーを作成

Bodyapplication/json
user_idstring(uuid)required

ユーザーID

emailstring(email)required

メールアドレス

user_statusstringrequired

ユーザーステータス

Enum"INVITED""ACTIVE""INACTIVE"
display_namestring[ 1 .. 48 ] charactersrequired

ユーザー名

profile_image_urlstring(uri)

プロフィール画像URL

user_rolesArray of stringsrequired

ユーザーに付与するロール リージョンごとに利用可能なロールが異なります

JP リージョン

  • ItAdmin (IT管理者)
  • MatterManagementPro (マターマネジメント: プロ)
  • MatterManagementStandard (マターマネジメント: スタンダード)
  • MatterManagementAdmin (マターマネジメント: 管理者)
  • ReviewStandard (レビュー: スタンダード)
  • ReviewStandardPlaybook (レビュー: スタンダード(プレイブック))
  • ReviewPro (レビュー: プロ)
  • ReviewBasicPlaybook (レビュー: ベーシック(プレイブック))
  • ReviewAdmin (レビュー: 管理者)
  • SignUser (サイン: 利用する)
  • SignAdmin (サイン: 管理者)
  • ContractManagementAdmin (コントラクトマネジメント: 管理者)
  • LegalonTemplatePro (Legalonテンプレート: プロ)
  • LegalonTemplateAdmin (Legalonテンプレート: 管理者)
  • MoriHamadaLibraryPro (MORI HAMADAライブラリー: プロ)
  • MoriHamadaLibraryAdmin (MORI HAMADAライブラリー: 管理者)
  • UniversalAssistStandard (ユニバーサルアシスト: スタンダード)
  • UniversalAssistAdmin (ユニバーサルアシスト: 管理者)
  • LegalonAssistantPro (Legalonアシスタント: プロ)
  • LegalonAssistantStandard (Legalonアシスタント: スタンダード)
  • LegalonAssistantAdmin (Legalonアシスタント: 管理者)

US リージョン

  • ItAdmin (IT管理者)
  • USMatterManagementPro (マターマネジメント: プロ)
  • MatterManagementStandard (マターマネジメント: スタンダード)
  • MatterManagementAdmin (マターマネジメント: 管理者)
  • USReviewPro (レビュー: プロ)
  • USReviewAdmin (レビュー: 管理者)
  • ContractManagementAdmin (コントラクトマネジメント: 管理者)
  • USLegalonAssistantPro (Legalonアシスタント: プロ)
  • LegalonAssistantStandard (Legalonアシスタント: スタンダード)
  • LegalonAssistantAdmin (Legalonアシスタント: 管理者)
  • TranslationPro (翻訳: プロ)
  • TranslationAdmin (翻訳: 管理者)
Response
application/json
{
  "user_id": "76088fa5-1ce5-3ca9-303a-8466c48581ba",
  "email": "user@example.com",
  "user_status": "ACTIVE",
  "display_name": "Legal Taro",
  "profile_image_url": "https://...",
  "user_roles": [
    "ItAdmin"
  ]
}

ユーザーを取得

Request

ユーザーを取得します

Security
OAuth2ClientCredentials
Path
user_idstring(uuid)required

ユーザーID

curl -i -X GET \
  'https://{api_base_url_without_scheme}/rest/v1/users/{user_id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

正常にユーザーを取得

Bodyapplication/json
user_idstring(uuid)required

ユーザーID

emailstring(email)required

メールアドレス

user_statusstringrequired

ユーザーステータス

Enum"INVITED""ACTIVE""INACTIVE"
display_namestring[ 1 .. 48 ] charactersrequired

ユーザー名

profile_image_urlstring(uri)

プロフィール画像URL

user_rolesArray of stringsrequired

ユーザーに付与するロール リージョンごとに利用可能なロールが異なります

JP リージョン

  • ItAdmin (IT管理者)
  • MatterManagementPro (マターマネジメント: プロ)
  • MatterManagementStandard (マターマネジメント: スタンダード)
  • MatterManagementAdmin (マターマネジメント: 管理者)
  • ReviewStandard (レビュー: スタンダード)
  • ReviewStandardPlaybook (レビュー: スタンダード(プレイブック))
  • ReviewPro (レビュー: プロ)
  • ReviewBasicPlaybook (レビュー: ベーシック(プレイブック))
  • ReviewAdmin (レビュー: 管理者)
  • SignUser (サイン: 利用する)
  • SignAdmin (サイン: 管理者)
  • ContractManagementAdmin (コントラクトマネジメント: 管理者)
  • LegalonTemplatePro (Legalonテンプレート: プロ)
  • LegalonTemplateAdmin (Legalonテンプレート: 管理者)
  • MoriHamadaLibraryPro (MORI HAMADAライブラリー: プロ)
  • MoriHamadaLibraryAdmin (MORI HAMADAライブラリー: 管理者)
  • UniversalAssistStandard (ユニバーサルアシスト: スタンダード)
  • UniversalAssistAdmin (ユニバーサルアシスト: 管理者)
  • LegalonAssistantPro (Legalonアシスタント: プロ)
  • LegalonAssistantStandard (Legalonアシスタント: スタンダード)
  • LegalonAssistantAdmin (Legalonアシスタント: 管理者)

US リージョン

  • ItAdmin (IT管理者)
  • USMatterManagementPro (マターマネジメント: プロ)
  • MatterManagementStandard (マターマネジメント: スタンダード)
  • MatterManagementAdmin (マターマネジメント: 管理者)
  • USReviewPro (レビュー: プロ)
  • USReviewAdmin (レビュー: 管理者)
  • ContractManagementAdmin (コントラクトマネジメント: 管理者)
  • USLegalonAssistantPro (Legalonアシスタント: プロ)
  • LegalonAssistantStandard (Legalonアシスタント: スタンダード)
  • LegalonAssistantAdmin (Legalonアシスタント: 管理者)
  • TranslationPro (翻訳: プロ)
  • TranslationAdmin (翻訳: 管理者)
Response
application/json
{
  "user_id": "76088fa5-1ce5-3ca9-303a-8466c48581ba",
  "email": "user@example.com",
  "user_status": "ACTIVE",
  "display_name": "Legal Taro",
  "profile_image_url": "https://...",
  "user_roles": [
    "ItAdmin"
  ]
}

ユーザーグループ

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

Operations

ワークスペース

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

Operations

部署

部署に関する操作

Operations