Users.psm1
|
function Get-GitlabUser { [CmdletBinding(DefaultParameterSetName='Filter')] param ( [Parameter(ParameterSetName='Id', Position=0, Mandatory, ValueFromPipelineByPropertyName)] [Alias('Id')] [Alias('Username')] [Alias('EmailAddress')] [string] $UserId, [Parameter(ParameterSetName='Filter')] [switch] $Active, [Parameter(ParameterSetName='Filter')] [switch] $External, [Parameter(ParameterSetName='Filter')] [switch] $Blocked, [Parameter(ParameterSetName='Filter')] [switch] $ExcludeActive, [Parameter(ParameterSetName='Filter')] [switch] $ExcludeExternal, [Parameter()] [uint] $MaxPages = 1, [switch] [Parameter()] $All, [Parameter(ParameterSetName='Me')] [switch] $Me, [Parameter()] [string] $SiteUrl ) $Parameters = @{ MaxPages = Get-GitlabMaxPages -MaxPages:$MaxPages -All:$All Method = 'GET' Path = 'users' # https://docs.gitlab.com/ee/api/users.html#for-non-administrator-users Query = @{} SiteUrl = $SiteUrl } if ($Active) { $Parameters.Query.active = 'true' } elseif ($ExcludeActive) { $Parameters.Query.exclude_active = 'true' } if ($External) { $Parameters.Query.external = 'true' } if ($ExcludeExternal) { $Parameters.Query.exclude_external = 'true' } if ($Blocked) { $Parameters.Query.blocked = 'true' } if ($PSCmdlet.ParameterSetName -eq 'Id') { if ($UserId -match '@') { $Parameters.Query.search = $UserId } else { if ([uint]::TryParse($UserId, [ref] $null)) { $Parameters.Path = "users/$UserId" # https://docs.gitlab.com/ee/api/users.html#single-user } else { $Parameters.Query.username = $UserId } } } elseif ($Me) { $Parameters.Path = 'user' # https://docs.gitlab.com/ee/api/users.html#for-non-administrator-users } Invoke-GitlabApi @Parameters | New-WrapperObject 'Gitlab.User' } function Block-GitlabUser { [CmdletBinding(SupportsShouldProcess, ConfirmImpact = 'Medium')] param ( [Parameter(Position=0, Mandatory, ValueFromPipelineByPropertyName)] [Alias('Id')] [Alias('Username')] [Alias('EmailAddress')] [string] $UserId, [Parameter()] [string] $SiteUrl ) $User = Get-GitlabUser $UserId if ($PSCmdlet.ShouldProcess("$($User.Username)", "block user")) { $Parameters = @{ # https://docs.gitlab.com/ee/api/users.html#block-user Method = 'POST' Path = "users/$($User.Id)/block" SiteUrl = $SiteUrl } if (Invoke-GitlabApi @Parameters) { Write-Host "$($User.Username) blocked" } } } function Unblock-GitlabUser { [CmdletBinding(SupportsShouldProcess, ConfirmImpact = 'Low')] param ( [Parameter(Position=0, Mandatory, ValueFromPipelineByPropertyName)] [Alias('Id')] [Alias('Username')] [Alias('EmailAddress')] [string] $UserId, [Parameter()] [string] $SiteUrl ) $User = Get-GitlabUser $UserId if ($PSCmdlet.ShouldProcess("$($User.Username)", "unblock user")) { $Parameters = @{ # https://docs.gitlab.com/ee/api/users.html#unblock-user Method = 'POST' Path = "users/$($User.Id)/unblock" SiteUrl = $SiteUrl } if (Invoke-GitlabApi @Parameters) { Write-Host "$($User.Username) unblocked" } } } # https://docs.gitlab.com/ee/api/events.html#get-user-contribution-events function Get-GitlabUserEvent { [CmdletBinding(DefaultParameterSetName='ByUserId')] param ( [Parameter(ParameterSetName='ByUserId', Mandatory=$false)] [Alias('Username')] [string] $UserId, [Parameter(ParameterSetName='ByEmail', Mandatory=$false)] [string] $EmailAddress, [Parameter(ParameterSetName='ByMe', Mandatory=$False)] [switch] $Me, [Parameter(Mandatory=$False)] [ValidateSet('approved', 'closed', 'commented', 'created', 'destroyed', 'expired', 'joined', 'left', 'merged', 'pushed', 'reopened', 'updated')] [string] $Action, [Parameter(Mandatory=$False)] [ValidateSet('issue', 'milestone', 'merge_request', 'note', 'project', 'snippet', 'user')] [string] $TargetType, [Parameter(Mandatory=$False)] [ValidateScript({ValidateGitlabDateFormat $_})] [string] $Before, [Parameter(Mandatory=$False)] [ValidateScript({ValidateGitlabDateFormat $_})] [string] $After, [Parameter(Mandatory=$False)] [ValidateSet('asc', 'desc')] [string] $Sort, [Parameter(Mandatory=$False)] [uint] $MaxPages = 1, [Parameter(Mandatory=$False)] [switch] $FetchProjects, [Parameter(Mandatory=$False)] [string] $SiteUrl, [switch] [Parameter(Mandatory=$false)] $WhatIf ) $GetUserParams = @{} if($PSCmdlet.ParameterSetName -eq 'ByUserId') { $GetUserParams.UserId = $UserId } if ($PSCmdLet.ParameterSetName -eq 'ByEmail') { $GetUserParams.UserId = $EmailAddress } if($PSCmdlet.ParameterSetName -eq 'ByMe') { $GetUserParams.Me = $true } $User = Get-GitlabUser @GetUserParams -SiteUrl $SiteUrl $Query = @{} if($Before) { $Query.before = $Before } if($After) { $Query.after = $After } if($Action) { $Query.action = $Action } if($Sort) { $Query.sort = $Sort } $Events = Invoke-GitlabApi GET "users/$($User.Id)/events" -Query $Query -MaxPages $MaxPages -SiteUrl $SiteUrl -WhatIf:$WhatIf | New-WrapperObject 'Gitlab.Event' if ($FetchProjects) { $ProjectIds = $Events.ProjectId | Select-Object -Unique $Projects = $ProjectIds | ForEach-Object { try { Get-GitlabProject $_ -WhatIf:$WhatIf -SiteUrl $SiteUrl } catch { $null } } $Events | ForEach-Object { $_ | Add-Member -MemberType 'NoteProperty' -Name 'Project' -Value $($Projects | Where-Object Id -eq $_.ProjectId) } } $Events } function Get-GitlabCurrentUser { [CmdletBinding()] param ( [Parameter()] [string] $SiteUrl ) Get-GitlabUser -Me -SiteUrl $SiteUrl } |