Skip to content
/
Update user

LegalOn API (0.9.0)

API documentation for LegalOn services

Servers
The server URL is `{api_base_url}/rest/v1`. You can construct the server URL using the value of `api_base_url` provided in the response when obtaining an access token.
https://{api_base_url_without_scheme}/rest/v1

Users

Operations about user

Operations

Get user

Request

Retrieve the user

Security
OAuth2ClientCredentials
Path
user_idstring(uuid)required

User ID

Responses

OK

Bodyapplication/json
user_idstring(uuid)required

User Id

emailstring(email)required

User email address

user_statusstringrequired

User status

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

User name

profile_image_urlstring(uri)

Profile image URL

user_rolesArray of stringsrequired

User roles Available roles vary by region

JP Region

  • ItAdmin (IT Admin)
  • MatterManagementPro (Matter Management: Pro)
  • MatterManagementStandard (Matter Management: Standard)
  • MatterManagementAdmin (Matter Management: Admin)
  • ReviewStandard (Review: Standard)
  • ReviewStandardPlaybook (Review: Standard (Playbook))
  • ReviewPro (Review: Pro)
  • ReviewBasicPlaybook (Review: Basic (Playbook))
  • ReviewAdmin (Review: Admin)
  • SignUser (Sign: User)
  • SignAdmin (Sign: Admin)
  • ContractManagementAdmin (Contract Management: Admin)
  • LegalonTemplatePro (Legalon Template: Pro)
  • LegalonTemplateAdmin (Legalon Template: Admin)
  • MoriHamadaLibraryPro (Mori Hamada Library: Pro)
  • MoriHamadaLibraryAdmin (Mori Hamada Library: Admin)
  • UniversalAssistStandard (Universal Assist: Standard)
  • UniversalAssistAdmin (Universal Assist: Admin)
  • LegalonAssistantPro (Legalon Assistant: Pro)
  • LegalonAssistantStandard (Legalon Assistant: Standard)
  • LegalonAssistantAdmin (Legalon Assistant: Admin)

US Region

  • ItAdmin (IT Admin)
  • USMatterManagementPro (Matter Management: Pro)
  • MatterManagementStandard (Matter Management: Standard)
  • MatterManagementAdmin (Matter Management: Admin)
  • USReviewPro (Review: Pro)
  • USReviewAdmin (Review: Admin)
  • ContractManagementAdmin (Contract Management: Admin)
  • USLegalonAssistantPro (Legalon Assistant: Pro)
  • LegalonAssistantStandard (Legalon Assistant: Standard)
  • LegalonAssistantAdmin (Legalon Assistant: Admin)
  • TranslationPro (Translation: Pro)
  • TranslationAdmin (Translation: Admin)
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"
  ]
}

Update user

Request

Update the user

Security
OAuth2ClientCredentials
Path
user_idstring(uuid)required

User ID

Bodyapplication/jsonrequired

User update request

user_statusstring

User status.If omitted, no update will be performed.

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

User roles.If omitted, no update will be performed.

Responses

OK

Bodyapplication/json
user_idstring(uuid)required

User Id

emailstring(email)required

User email address

user_statusstringrequired

User status

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

User name

profile_image_urlstring(uri)

Profile image URL

user_rolesArray of stringsrequired

User roles Available roles vary by region

JP Region

  • ItAdmin (IT Admin)
  • MatterManagementPro (Matter Management: Pro)
  • MatterManagementStandard (Matter Management: Standard)
  • MatterManagementAdmin (Matter Management: Admin)
  • ReviewStandard (Review: Standard)
  • ReviewStandardPlaybook (Review: Standard (Playbook))
  • ReviewPro (Review: Pro)
  • ReviewBasicPlaybook (Review: Basic (Playbook))
  • ReviewAdmin (Review: Admin)
  • SignUser (Sign: User)
  • SignAdmin (Sign: Admin)
  • ContractManagementAdmin (Contract Management: Admin)
  • LegalonTemplatePro (Legalon Template: Pro)
  • LegalonTemplateAdmin (Legalon Template: Admin)
  • MoriHamadaLibraryPro (Mori Hamada Library: Pro)
  • MoriHamadaLibraryAdmin (Mori Hamada Library: Admin)
  • UniversalAssistStandard (Universal Assist: Standard)
  • UniversalAssistAdmin (Universal Assist: Admin)
  • LegalonAssistantPro (Legalon Assistant: Pro)
  • LegalonAssistantStandard (Legalon Assistant: Standard)
  • LegalonAssistantAdmin (Legalon Assistant: Admin)

US Region

  • ItAdmin (IT Admin)
  • USMatterManagementPro (Matter Management: Pro)
  • MatterManagementStandard (Matter Management: Standard)
  • MatterManagementAdmin (Matter Management: Admin)
  • USReviewPro (Review: Pro)
  • USReviewAdmin (Review: Admin)
  • ContractManagementAdmin (Contract Management: Admin)
  • USLegalonAssistantPro (Legalon Assistant: Pro)
  • LegalonAssistantStandard (Legalon Assistant: Standard)
  • LegalonAssistantAdmin (Legalon Assistant: Admin)
  • TranslationPro (Translation: Pro)
  • TranslationAdmin (Translation: Admin)
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"
  ]
}

User Groups

Operations about user group

Operations

Workspaces

Operations about workspace/folder

Operations

Departments

Operations about department

Operations