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

ユーザーを取得

Request

ユーザーを取得します

Security
OAuth2ClientCredentials
Path
user_idstring(uuid)required

LegalOnが生成したユーザー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

LegalOnが生成したユーザーID

emailstring(email)required

メールアドレス

user_statusstringrequired

ユーザーステータス

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

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

profile_image_urlstring(uri)

プロフィール画像URL

user_rolesArray of stringsrequired

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

JP リージョン

  • ItAdmin (IT管理者)
  • ApiCredentialIssuer (API利用権限)
  • 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管理者)
  • ApiCredentialIssuer (API利用権限)
  • 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

ユーザーを更新します。 招待中ユーザーの招待を取り消す場合は、user_statusをINACTIVEに設定するのではなくDELETE /users/{user_id}/invitationsを使用してください。 user_statusをINVITEDに設定しても招待は再送されません。

Security
OAuth2ClientCredentials
Path
user_idstring(uuid)required

LegalOnが生成したユーザーID

Bodyapplication/jsonrequired

ユーザー更新リクエスト

user_statusstring

ユーザーステータス。省略した場合は更新しない。 ステータスをINVITEDからACTIVEまたはINACTIVEに更新することはできません。 ステータスをACTIVEまたはINACTIVEからINVITEDに更新することはできません。 ステータスをACTIVEからINACTIVEに変更した場合、そのユーザーは所属しているユーザーグループに所属したままになります。

Enum"INVITED""ACTIVE""INACTIVE"
user_rolesArray of strings

ユーザーに付与するロール。省略した場合は更新しない。

curl -i -X PATCH \
  'https://{api_base_url_without_scheme}/rest/v1/users/{user_id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "user_status": "INVITED",
    "user_roles": [
      "string"
    ]
  }'

Responses

正常にユーザーを更新

Bodyapplication/json
user_idstring(uuid)required

LegalOnが生成したユーザーID

emailstring(email)required

メールアドレス

user_statusstringrequired

ユーザーステータス

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

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

profile_image_urlstring(uri)

プロフィール画像URL

user_rolesArray of stringsrequired

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

JP リージョン

  • ItAdmin (IT管理者)
  • ApiCredentialIssuer (API利用権限)
  • 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管理者)
  • ApiCredentialIssuer (API利用権限)
  • 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

招待中（INVITEDステータス）ユーザーの未承諾の招待を取り消します。

Security
OAuth2ClientCredentials
Path
user_idstring(uuid)required

ユーザーID

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

Responses

正常にユーザー招待を取り消し

Response
No content

ユーザーグループ

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

Operations

ワークスペース

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

Operations

部署

部署に関する操作

Operations

契約書（ファイル）

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

Operations

ワークスペース

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

Operations