Add-MatterUserAccessEntry

Summary

Creates a new matter user access entry.

Add-MatterUserAccessEntry
    -Entry

Returns the created matter user access entry object.

Parameters

Examples

Create a new matter user access entry

# Create a matter user access entry object with required fields
$entry = @{
    MatterId = 6
    UserId = "521d1513-a164-41a5-b5cf-64964a210503"
}

$createdEntry = Add-MatterUserAccessEntry -Entry $entry

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

# For debug purposes, convert the data to output as JSON so we can see all the fields
Write-Output ""
Write-Output "JSON Results:"

$jsonOutput = $createdEntry | ConvertTo-Json -Depth 10

# Output the data
Write-Output $jsonOutput

Execution results:

Created matter user access entry 73: Allow List (Document Reviewers entry for matter Alpha Widgets v. Alpha Gadgets)

JSON Results:
{
  "MatterUserAccessId": 73,
  "Matter": null,
  "MatterId": 6,
  "MatterName": "Alpha Widgets v. Alpha Gadgets",
  "MatterReference": "100002",
  "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-18T14:13:38.0443795+00:00",
  "CreatedBy": null,
  "LastUpdatedByFullName": "Max Miller",
  "LastUpdatedById": "510e109b-6ff5-4442-9670-cd5e3cd82a7a",
  "LastUpdatedOn": "2026-01-18T14:13:38.0443795+00:00",
  "LastUpdatedBy": null
}