Public/Group/Get-Group.ps1
|
<# .SYNOPSIS Retrieves Group(s) based on a set of parameters. .DESCRIPTION Retrieves one or more Group resources found under a given parent Organization and matches given search parameters. A user with GROUP.READ will be allowed to retrieve groups from an organization. For query by memberId of an identity that is assigned across organizations (such as SERVICE), this API retrieves all groups assigned to the identity irrespective of organization .INPUTS Accepts the group identifier .OUTPUTS A group resource object The group object returned has following methods with corresponding cmdlet pass through: Managing group identity: - SetIdentity calls Set-GroupIdentity - RemoveIdentity calls Remove-GroupIdentity Managing roles: - SetRole calls Set-GroupRole - RemoveRole calls Remove-GroupRole Managing Members: - SetMember calls Set-GroupMember - RemoveMember calls Remove-GroupMember .PARAMETER Id The group identifier .EXAMPLE $group = Get-Group -Id "21c26a46-83d1-429d-b29c-d3c0b75d925e" .LINK https://www.hsdp.io/documentation/identity-and-access-management-iam/api-documents/resource-reference-api/user-api/group-api#/Group%20Management/get_authorize_identity_Group__id_ .NOTES GET: /authorize/identity/Group/{id} v1 #> function Get-Group { [CmdletBinding()] [OutputType([PSObject])] param( [Parameter(Mandatory, Position = 0, ValueFromPipeline)] [ValidateNotNullOrEmpty()] [String]$Id ) begin { Write-Verbose "[$($MyInvocation.MyCommand.Name)] Function started" } process { Write-Debug "[$($MyInvocation.MyCommand.Name)] PSBoundParameters: $($PSBoundParameters | Out-String)" $response = (Invoke-GetRequest -Path "/authorize/identity/Group/$($Id)" -Version 1) $group = @($response) $group | Add-Member -MemberType ScriptMethod -Name "SetIdentity" -Value { param($Ids) $this | Set-GroupIdentity -Ids $Ids } $group | Add-Member -MemberType ScriptMethod -Name "RemoveIdentity" -Value { param($Ids) $this | Remove-GroupIdentity -Ids $Ids } $group | Add-Member -MemberType ScriptMethod -Name "SetRole" -Value { param($Role) $this | Set-GroupRole -Roles @($Role) } $group | Add-Member -MemberType ScriptMethod -Name "RemoveRole" -Value { param($Role) $this | Remove-GroupRole -Role $Role } $group | Add-Member -MemberType ScriptMethod -Name "SetMember" -Value { param($User) $this | Set-GroupMember -User $User } $group | Add-Member -MemberType ScriptMethod -Name "RemoveMember" -Value { param($User) $this | Remove-GroupMember -User $User } Write-Output $group } end { Write-Verbose "[$($MyInvocation.MyCommand.Name)] Complete" } } |