Add-TeamUser

Prev Next

Summary

Creates a new team user.

Add-TeamUser
    -Entry

Returns the created team user object.

Parameters

Parameter

Type

Required?

Notes

Entry

Team User

Yes


Examples

Add a user to a team

# Create a team user object with required fields
$teamUser = @{
    TeamId = "34e89524-1052-4381-a19a-083a20de9514"
    UserId = "08077d23-bb13-4727-b76d-ab8fdf9d870f"
}

$teamUser = Add-TeamUser -Entry $teamUser

# Output some information to help indicate that the team user was created
Write-Output "Added user '$($teamUser.UserFullName)' to team '$($teamUser.TeamName)' (Id: #$($teamUser.TeamUserId))"

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

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

# Output the data
Write-Output $jsonOutput

Execution results:

Added user 'Max Miller' to team 'Processing' (Id: #10)

JSON Results:
{
  "TeamUserId": 10,
  "TeamId": "34e89524-1052-4381-a19a-083a20de9514",
  "UserId": "08077d23-bb13-4727-b76d-ab8fdf9d870f",
  "Team": null,
  "TeamName": "Processing",
  "User": null,
  "UserFullName": "Max Miller",
  "UserEmail": "mmiller@agilityblue.com",
  "UserActive": true,
  "CreatedByFullName": "Max Miller",
  "CreatedById": "510e109b-6ff5-4442-9670-cd5e3cd82a7a",
  "CreatedOn": "2026-01-20T20:13:48.6160196+00:00",
  "CreatedBy": null,
  "LastUpdatedByFullName": "Max Miller",
  "LastUpdatedById": "510e109b-6ff5-4442-9670-cd5e3cd82a7a",
  "LastUpdatedOn": "2026-01-20T20:13:48.6160196+00:00",
  "LastUpdatedBy": null
}