Get-MatterUserAccessEntry

Prev Next

Summary

Retrieves an existing matter user access entry.

Get-MatterUserAccessEntry
    -Id

Returns a matter user access entry object.

Parameters

Parameter

Type

Required?

Notes

Id

Int32

Yes

The matter user access entry id.

Examples

Get an existing matter user access entry

# Retrieve a specific matter user access entry by id
$entity = Get-MatterUserAccessEntry -Id 21

Write-Output "Retrieved matter user access entry $($entity.MatterUserAccessId): $($entity.MatterAccessStateName) ($($entity.UserFullName) entry for matter $($entity.MatterName))"

# For debug purposes, convert the matter user access entry to output as JSON so we can see the available fields
Write-Output ""
Write-Output "JSON Results:"

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

# Output the entity
Write-Output $jsonOutput

Execution results:

Retrieved matter user access entry 21: Allow List (Document Reviewers entry for matter National Fencing v. Epsilon Construction, et al.)

JSON Results:
{
  "MatterUserAccessId": 21,
  "Matter": null,
  "MatterId": 10,
  "MatterName": "National Fencing v. Epsilon Construction, et al.",
  "MatterReference": "1040.0002",
  "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": "2024-06-26T16:16:33.5946625+00:00",
  "CreatedBy": null,
  "LastUpdatedByFullName": "Max Miller",
  "LastUpdatedById": "510e109b-6ff5-4442-9670-cd5e3cd82a7a",
  "LastUpdatedOn": "2024-06-26T16:16:33.5946625+00:00",
  "LastUpdatedBy": null
}