internal/autorest/out/system/Get-DracoonARSystemConfigSettingGeneral.ps1
|
function Get-DracoonARSystemConfigSettingGeneral { <# .SYNOPSIS Request general settings .DESCRIPTION <h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>🚀 Since v4.6.0</h3> ### Description: DRACOON general settings configuration entry point. ### Precondition: Right <span style='padding: 3px; background-color: #F6F7F8; border: 1px solid #000; border-radius: 5px; display: inline;'>🔓 read global config</span> and role <span style='padding: 3px; background-color: #F6F7F8; border: 1px solid #000; border-radius: 5px; display: inline;'>👤 Config Manager</span> of the Provider Customer required. ### Postcondition: Returns a list of configurable general settings. ### Further Information: ### Auth token restrictions: A restriction is a lower bound for a token timeout and defines a duration after which a token is invalidated when it wasn't used. The access/refresh token validity duration of the client is the upper bound. A token is invalidated - in any case - when it has passed. Auth token restrictions are enabled by default. * Default access token validity: **2 hours** * Default refresh token validity: **30 days** ### Configurable general settings: <details open style="padding: 10px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px;"> <summary style="cursor: pointer; outline: none"><strong>Expand</strong></summary> | Setting | Description | Value | | :--- | :--- | :--- | | `sharePasswordSmsEnabled` | Determines whether sending of share passwords via SMS is allowed. | `true or false` | | `cryptoEnabled` | Determines whether client-side encryption is enabled.<br>Can only be enabled once; disabling is **NOT** possible. | `true or false` | | `emailNotificationButtonEnabled` | Determines whether email notification button is enabled. | `true or false` | | `eulaEnabled` | Determines whether EULA is enabled.<br>Each user has to confirm the EULA at first login. | `true or false` | | `useS3Storage` | Defines if S3 is used as storage backend.<br>Can only be enabled once; disabling is **NOT** possible. | `true or false` | | `s3TagsEnabled` | Determines whether S3 tags are enabled | `true or false` | | `hideLoginInputFields` | Determines whether input fields for login should be enabled | `true or false` | | `authTokenRestrictions` | Determines auth token restrictions. (e.g. restricted access token validity) | `object` | </details> ### Deprecated configurable general settings: <details style="padding: 10px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px;"> <summary style="cursor: pointer; outline: none"><strong>Expand</strong></summary> | Setting | Description | Value | | :--- | :--- | :--- | | <del>`mediaServerEnabled`</del> | Determines whether media server is enabled.<br>Returns boolean value dependent on conjunction of `mediaServerConfigEnabled` AND `mediaServerEnabled` | `true or false` | | <del>`weakPasswordEnabled`</del> | Determines whether weak password is allowed.<br>Use `GET /system/config/policies/passwords` API to get configured password policies. | `true or false` | </details> .PARAMETER Connection Object of Class ARAHConnection, stores the authentication Token and the API Base-URL .PARAMETER XSdsAuthToken Authentication token .EXAMPLE PS C:\> Get-DracoonARSystemConfigSettingGeneral -Connection $connection <h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>🚀 Since v4.6.0</h3> ### Description: DRACOON general settings configuration entry point. ### Precondition: Right <span style='padding: 3px; background-color: #F6F7F8; border: 1px solid #000; border-radius: 5px; display: inline;'>🔓 read global config</span> and role <span style='padding: 3px; background-color: #F6F7F8; border: 1px solid #000; border-radius: 5px; display: inline;'>👤 Config Manager</span> of the Provider Customer required. ### Postcondition: Returns a list of configurable general settings. ### Further Information: ### Auth token restrictions: A restriction is a lower bound for a token timeout and defines a duration after which a token is invalidated when it wasn't used. The access/refresh token validity duration of the client is the upper bound. A token is invalidated - in any case - when it has passed. Auth token restrictions are enabled by default. * Default access token validity: **2 hours** * Default refresh token validity: **30 days** ### Configurable general settings: <details open style="padding: 10px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px;"> <summary style="cursor: pointer; outline: none"><strong>Expand</strong></summary> | Setting | Description | Value | | :--- | :--- | :--- | | `sharePasswordSmsEnabled` | Determines whether sending of share passwords via SMS is allowed. | `true or false` | | `cryptoEnabled` | Determines whether client-side encryption is enabled.<br>Can only be enabled once; disabling is **NOT** possible. | `true or false` | | `emailNotificationButtonEnabled` | Determines whether email notification button is enabled. | `true or false` | | `eulaEnabled` | Determines whether EULA is enabled.<br>Each user has to confirm the EULA at first login. | `true or false` | | `useS3Storage` | Defines if S3 is used as storage backend.<br>Can only be enabled once; disabling is **NOT** possible. | `true or false` | | `s3TagsEnabled` | Determines whether S3 tags are enabled | `true or false` | | `hideLoginInputFields` | Determines whether input fields for login should be enabled | `true or false` | | `authTokenRestrictions` | Determines auth token restrictions. (e.g. restricted access token validity) | `object` | </details> ### Deprecated configurable general settings: <details style="padding: 10px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px;"> <summary style="cursor: pointer; outline: none"><strong>Expand</strong></summary> | Setting | Description | Value | | :--- | :--- | :--- | | <del>`mediaServerEnabled`</del> | Determines whether media server is enabled.<br>Returns boolean value dependent on conjunction of `mediaServerConfigEnabled` AND `mediaServerEnabled` | `true or false` | | <del>`weakPasswordEnabled`</del> | Determines whether weak password is allowed.<br>Use `GET /system/config/policies/passwords` API to get configured password policies. | `true or false` | </details> .LINK <unknown> #> [CmdletBinding(DefaultParameterSetName = 'default')] param ( [Parameter(Mandatory = $true, ValueFromPipelineByPropertyName = $true, ParameterSetName = 'default')] [object] $Connection, [Parameter(ValueFromPipelineByPropertyName = $true, ParameterSetName = 'default')] [string] $XSdsAuthToken ) process { $__mapping = @{ 'Connection' = 'Connection' 'XSdsAuthToken' = 'X-Sds-Auth-Token' } $__body = $PSBoundParameters | ConvertTo-DracoonARHashtable -Include @() -Mapping $__mapping $__query = $PSBoundParameters | ConvertTo-DracoonARHashtable -Include @() -Mapping $__mapping $__header = $PSBoundParameters | ConvertTo-DracoonARHashtable -Include @('XSdsAuthToken') -Mapping $__mapping $__path = 'system/config/settings/general' Invoke-DracoonAPI -Path $__path -Method get -Body $__body -Query $__query -Header $__header -Connection $Connection } } |