Set-MatterUserAccessEntry

Prev Next

Summary

Updates an existing matter user access entry.

Set-MatterUserAccessEntry
    -Entry

Returns a matter user access entry object.

Parameters

Parameter

Type

Required?

Notes

Entry

Matter User Access Entry Object

Yes


Examples

Move an existing matter user access entry to a different matter

# Retrieve an existing matter user access entry
$matterUserAccessEntry = Get-MatterUserAccessEntry -Id 74

# Change the matter
$matterUserAccessEntry.MatterId = 30

# Save changes
$matterUserAccessEntry = Set-MatterUserAccessEntry -Entry $matterUserAccessEntry

# Output some information to help indicate that the entry was created
Write-Output "Updated matter user access entry $($matterUserAccessEntry.MatterUserAccessId): $($matterUserAccessEntry.MatterAccessStateName) ($($matterUserAccessEntry.UserFullName) entry to matter $($matterUserAccessEntry.MatterName))"

# For debug purposes, convert the entry to output as JSON so we can see the available fields
$jsonOutput = $matterUserAccessEntry | ConvertTo-Json -Depth 10

Write-Output ""
Write-Output "JSON Results:"

# Output the JSON results
Write-Output $jsonOutput

Execution results:

Updated matter user access entry 74: Allow List (Document Reviewers entry to matter Johnson, et al v. Grant and Gabriel Energy)

JSON Results:
{
  "MatterUserAccessId": 74,
  "Matter": null,
  "MatterId": 30,
  "MatterName": "Johnson, et al v. Grant and Gabriel Energy",
  "MatterReference": "7235-0789",
  "MatterIsActive": true,
  "MatterAccessStateId": 5,
  "MatterAccessStateName": "Allow List",
  "UserId": "521d1513-a164-41a5-b5cf-64964a210503",
  "User": null,
  "UserFullName": "Document Reviewers",
  "UserEmail": "team-521d1513-a164-41a5-b5cf-64964a210503@agilityblue.com",
  "UserIsActive": true,
  "UserIsSystemAccount": false,
  "UserIsTeamAccount": true,
  "UserIsOrganizationAdmin": false,
  "UserIsPortalOnlyUser": false,
  "CreatedByFullName": "Max Miller",
  "CreatedById": "510e109b-6ff5-4442-9670-cd5e3cd82a7a",
  "CreatedOn": "2026-01-19T15:25:14.8708219+00:00",
  "CreatedBy": null,
  "LastUpdatedByFullName": "Max Miller",
  "LastUpdatedById": "510e109b-6ff5-4442-9670-cd5e3cd82a7a",
  "LastUpdatedOn": "2026-01-19T15:28:43.06059+00:00",
  "LastUpdatedBy": null
}