Dracoon

1.5.2

internal/autorest/out/groups/Get-DracoonARGroup.ps1

                                function Get-DracoonARGroup {

<#

.SYNOPSIS

    Request list of user groups

.DESCRIPTION

    ### Description:  

Returns a list of user groups.

### Precondition:

Right <span style='padding: 3px; background-color: #F6F7F8; border: 1px solid #000; border-radius: 5px; display: inline;'>&#128275; read groups</span> required.

### Postcondition: 

List of user groups is returned.

### Further Information:

### Filtering:

All filter fields are connected via logical conjunction (**AND**)  

Filter string syntax: `FIELD_NAME:OPERATOR:VALUE`  

<details style="padding-left: 10px">

<summary style="cursor: pointer; outline: none"><strong>Example</strong></summary>

`name:cn:searchString`  

Filter by group name containing `searchString`.

</details>

### Filtering options:

<details style="padding: 10px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px;">

<summary style="cursor: pointer; outline: none"><strong>Expand</strong></summary>

| `FIELD_NAME` | Filter Description | `OPERATOR` | Operator Description | `VALUE` |

| :--- | :--- | :--- | :--- | :--- |

| `name` | Group name filter | `cn` | Group name contains value. | `search String` |

| `hasRole` | (**`NEW`**) Group role filter<br>For more information about roles check **`GET /roles`** API | `eq` | Group role equals value. | <ul><li>`CONFIG_MANAGER` - Manages global configuration</li><li>`USER_MANAGER` - Manages users</li><li>`GROUP_MANAGER` - Manages user groups</li><li>`ROOM_MANAGER` - Manages top level rooms</li><li>`LOG_AUDITOR` - Reads audit logs</li><li>`NONMEMBER_VIEWER` - Views users and groups when having room _"manage"_ permission</li></ul> |

</details>

---

### Sorting:

Sort string syntax: `FIELD_NAME:ORDER`  

`ORDER` can be `asc` or `desc`.  

Multiple sort fields are supported.  

<details style="padding-left: 10px">

<summary style="cursor: pointer; outline: none"><strong>Example</strong></summary>

`name:asc|expireAt:desc`  

Sort by `name` ascending **AND** by `expireAt` descending.

</details>

### Sorting options:

<details style="padding: 10px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px;">

<summary style="cursor: pointer; outline: none"><strong>Expand</strong></summary>

| `FIELD_NAME` | Description |

| :--- | :--- |

| `name` | Group name |

| `createdAt` | Creation date |

| `expireAt` | Expiration date |

| `cntUsers` | Amount of users |

</details>

.PARAMETER XSdsAuthToken

    Authentication token

.PARAMETER Connection

    Object of Class ARAHConnection, stores the authentication Token and the API Base-URL

.PARAMETER Filter

    Filter string

.PARAMETER Offset

    Range offset

.PARAMETER XSdsDateFormat

    Date time format (cf. [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) & [leettime.de](http://leettime.de/))

.PARAMETER Limit

    Range limit.

Maximum 500.

 For more results please use paging (`offset` + `limit`).

.PARAMETER Sort

    Sort string

.PARAMETER Group_id

    Group ID

.EXAMPLE

    PS C:\> Get-DracoonARGroup -Connection $connection

    ### Description:  

Returns a list of user groups.

### Precondition:

Right <span style='padding: 3px; background-color: #F6F7F8; border: 1px solid #000; border-radius: 5px; display: inline;'>&#128275; read groups</span> required.

### Postcondition: 

List of user groups is returned.

### Further Information:

### Filtering:

All filter fields are connected via logical conjunction (**AND**)  

Filter string syntax: `FIELD_NAME:OPERATOR:VALUE`  

<details style="padding-left: 10px">

<summary style="cursor: pointer; outline: none"><strong>Example</strong></summary>

`name:cn:searchString`  

Filter by group name containing `searchString`.

</details>

### Filtering options:

<details style="padding: 10px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px;">

<summary style="cursor: pointer; outline: none"><strong>Expand</strong></summary>

| `FIELD_NAME` | Filter Description | `OPERATOR` | Operator Description | `VALUE` |

| :--- | :--- | :--- | :--- | :--- |

| `name` | Group name filter | `cn` | Group name contains value. | `search String` |

| `hasRole` | (**`NEW`**) Group role filter<br>For more information about roles check **`GET /roles`** API | `eq` | Group role equals value. | <ul><li>`CONFIG_MANAGER` - Manages global configuration</li><li>`USER_MANAGER` - Manages users</li><li>`GROUP_MANAGER` - Manages user groups</li><li>`ROOM_MANAGER` - Manages top level rooms</li><li>`LOG_AUDITOR` - Reads audit logs</li><li>`NONMEMBER_VIEWER` - Views users and groups when having room _"manage"_ permission</li></ul> |

</details>

---

### Sorting:

Sort string syntax: `FIELD_NAME:ORDER`  

`ORDER` can be `asc` or `desc`.  

Multiple sort fields are supported.  

<details style="padding-left: 10px">

<summary style="cursor: pointer; outline: none"><strong>Example</strong></summary>

`name:asc|expireAt:desc`  

Sort by `name` ascending **AND** by `expireAt` descending.

</details>

### Sorting options:

<details style="padding: 10px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px;">

<summary style="cursor: pointer; outline: none"><strong>Expand</strong></summary>

| `FIELD_NAME` | Description |

| :--- | :--- |

| `name` | Group name |

| `createdAt` | Creation date |

| `expireAt` | Expiration date |

| `cntUsers` | Amount of users |

</details>

.EXAMPLE

    PS C:\> Get-DracoonARGroup -Group_id $group_id

    ### Description:  

Retrieve detailed information about a user group.

### Precondition:

Right <span style='padding: 3px; background-color: #F6F7F8; border: 1px solid #000; border-radius: 5px; display: inline;'>&#128275; read groups</span> required.

### Postcondition: 

User group is returned.

### Further Information:

None.

.LINK

    <unknown>

#>

    [CmdletBinding(DefaultParameterSetName = 'default')]

    param (

        [Parameter(ValueFromPipelineByPropertyName = $true, ParameterSetName = 'default')]

        [Parameter(ValueFromPipelineByPropertyName = $true, ParameterSetName = 'requestGroup')]

        [string]

        $XSdsAuthToken,

        [Parameter(Mandatory = $true, ValueFromPipelineByPropertyName = $true, ParameterSetName = 'default')]

        [object]

        $Connection,

        [Parameter(ValueFromPipelineByPropertyName = $true, ParameterSetName = 'default')]

        [string]

        $Filter,

        [Parameter(ValueFromPipelineByPropertyName = $true, ParameterSetName = 'default')]

        [object]

        $Offset,

        [Parameter(ValueFromPipelineByPropertyName = $true, ParameterSetName = 'default')]

        [Parameter(ValueFromPipelineByPropertyName = $true, ParameterSetName = 'requestGroup')]

        [object]

        $XSdsDateFormat,

        [Parameter(ValueFromPipelineByPropertyName = $true, ParameterSetName = 'default')]

        [object]

        $Limit,

        [Parameter(ValueFromPipelineByPropertyName = $true, ParameterSetName = 'default')]

        [string]

        $Sort,

        [Parameter(Mandatory = $true, ValueFromPipelineByPropertyName = $true, ParameterSetName = 'requestGroup')]

        [string]

        $Group_id

    )

    process {

        $__mapping = @{

            'XSdsAuthToken' = 'X-Sds-Auth-Token'

            'Connection' = 'Connection'

            'Filter' = 'filter'

            'Offset' = 'offset'

            'XSdsDateFormat' = 'X-Sds-Date-Format'

            'Limit' = 'limit'

            'Sort' = 'sort'

        }

        $__body = $PSBoundParameters | ConvertTo-DracoonARHashtable -Include @() -Mapping $__mapping

        $__query = $PSBoundParameters | ConvertTo-DracoonARHashtable -Include @('Filter','Offset','Limit','Sort') -Mapping $__mapping

        $__header = $PSBoundParameters | ConvertTo-DracoonARHashtable -Include @('XSdsAuthToken','XSdsDateFormat') -Mapping $__mapping

        $__path = 'groups'

        if ($Group_id) { $__path += "/$Group_id" }

        Invoke-DracoonAPI -Path $__path -Method get -Body $__body -Query $__query -Header $__header -Connection $Connection

    }

}