Skip to content
/
Get user

LegalOn API (1.1.0)

API documentation for LegalOn services

Languages
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

Create user

Request

Create a new user

Security
OAuth2ClientCredentials
Bodyapplication/jsonrequired

User creation request

display_namestring[ 1 .. 48 ] charactersrequired

User name. Both full-width and half-width characters count as one character. Duplicate display names are allowed in LegalOn.

emailstring(email)required

User email address. Duplicate email addresses cannot be registered in LegalOn.

user_rolesArray of stringsrequired

User roles

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

Created

Bodyapplication/json
user_idstring(uuid)required

LegalOn-generated user ID

emailstring(email)required

User email address

user_statusstringrequired

User status

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

User name. Both full-width and half-width characters count as one character.

profile_image_urlstring(uri)

Profile image URL

user_rolesArray of stringsrequired

User roles Available roles vary by region

JP Region

  • ItAdmin (IT Admin)
  • ApiCredentialIssuer (API access permission)
  • 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)
  • ApiCredentialIssuer (API access permission)
  • 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"
  ]
}

Get user

Request

Retrieve the user

Security
OAuth2ClientCredentials
Path
user_idstring(uuid)required

LegalOn-generated user ID

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

Responses

OK

Bodyapplication/json
user_idstring(uuid)required

LegalOn-generated user ID

emailstring(email)required

User email address

user_statusstringrequired

User status

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

User name. Both full-width and half-width characters count as one character.

profile_image_urlstring(uri)

Profile image URL

user_rolesArray of stringsrequired

User roles Available roles vary by region

JP Region

  • ItAdmin (IT Admin)
  • ApiCredentialIssuer (API access permission)
  • 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)
  • ApiCredentialIssuer (API access permission)
  • 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. To cancel the invitation for an invited user, use DELETE /users/{user_id}/invitations instead of setting user_status to INACTIVE. Setting user_status to INVITED does not resend an invitation.

Security
OAuth2ClientCredentials
Path
user_idstring(uuid)required

LegalOn-generated user ID

Bodyapplication/jsonrequired

User update request

user_statusstring

User status. If omitted, no update will be performed. The status cannot be changed from INVITED to ACTIVE or INACTIVE. The status cannot be changed from ACTIVE or INACTIVE to INVITED. When the status is changed from ACTIVE to INACTIVE, the user remains a member of their user groups.

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

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

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

OK

Bodyapplication/json
user_idstring(uuid)required

LegalOn-generated user ID

emailstring(email)required

User email address

user_statusstringrequired

User status

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

User name. Both full-width and half-width characters count as one character.

profile_image_urlstring(uri)

Profile image URL

user_rolesArray of stringsrequired

User roles Available roles vary by region

JP Region

  • ItAdmin (IT Admin)
  • ApiCredentialIssuer (API access permission)
  • 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)
  • ApiCredentialIssuer (API access permission)
  • 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 all tenant workspaces/folders regardless of the user's access permissions.

Operations

Departments

Operations about department

Operations

Contracts(Files)

Operations to create, retrieve, update, and delete contracts. For operations that target a workspace, specify a workspace_id obtained via the common Workspaces endpoint (GET /workspaces).

Operations

Workspaces

Workspaces/folders are the common units used to store and organize resources such as contracts. This endpoint returns the workspaces/folders the calling user has access to, as a tree. For operations that target a workspace (e.g., the Contract API), specify the workspace_id obtained here. To manage workspaces across the tenant (creation, permissions, etc.), see the admin workspace operations (/spaces).

Operations