< Back
Add-JiraFilterPermission
Post
NAME Add-JiraFilterPermission
SYNOPSIS
Share a Filter with other users.
SYNTAX
Add-JiraFilterPermission [-Filter] <JiraPS.Filter> [-Type] {Group | Project | ProjectRole | Authenticated |
Global} [[-Value] <String>] [[-Credential] <PSCredential>] [-WhatIf] [-Confirm] [<CommonParameters>]
Add-JiraFilterPermission [-Id] <UInt32[]> [-Type] {Group | Project | ProjectRole | Authenticated | Global}
[[-Value] <String>] [[-Credential] <PSCredential>] [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
Share a Filter with other users, such as "Group", "Project", "ProjectRole", "Authenticated" or "Global".
PARAMETERS
-Filter <JiraPS.Filter>
Filter object to which the permission should be applied
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-Id <UInt32[]>
Id of the Filter to which the permission should be applied Id can be passed over the pipeline when reading
from a file.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-Type <String>
Type of the permission to add
Required? true
Position? 1
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Value <String>
Value for the Type of the permission.
The Value differs per Type of the permission.
Here is a table to know what Value to provide: |Type |Value |Source
|
|-------------|---------------------|----------------------------------------------------| |Group |Name
of the Group |Can be retrieved with `(Get-JiraGroup ...).Name` | |Project |Id of the Project
|Can be retrieved with `(Get-JiraProject ...).Id` | |ProjectRole |Id of the ProjectRole|Can be retrieved
with `(Get-JiraProjectRole ...).Id`| |Authenticated| must be null |
| |Global | must be null | |
Required? false
Position? 2
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Credential <PSCredential>
Credentials to use to connect to JIRA.
If not specified, this function will use anonymous access.
Required? false
Position? 3
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
[JiraPS.Filter]
OUTPUTS
[JiraPS.Filter]
NOTES
This functions does not validate the input for `-Value`. In case the value is invalid, unexpected or missing,
the API will response with an error.
This function requires either the `-Credential` parameter to be passed or a persistent JIRA session. See
`New-JiraSession` for more details. If neither are supplied, this function will run with anonymous access to
JIRA.
-------------------------- Example 1 --------------------------
Add-JiraFilterPermission -Filter (Get-JiraFilter 12345) -Type "Global"
#-------
Add-JiraFilterPermission -Id 12345 -Type "Global"
Two methods of sharing Filter 12345 with everyone.
-------------------------- Example 2 --------------------------
12345 | Add-JiraFilterPermission -Type "Authenticated"
Share Filter 12345 with authenticated users. The Id could be read from a file.
-------------------------- Example 3 --------------------------
Get-JiraFilter 12345 | Add-JiraFilterPermission -Type "Group" -Value "administrators"
Share Filter 12345 only with users in the administrators groups.
RELATED LINKS
Online Version: https://atlassianps.org/docs/JiraPS/com ... ermission/
Get-JiraFilter
Get-JiraFilterPermission
Remove-JiraFilterPermission
SYNOPSIS
Share a Filter with other users.
SYNTAX
Add-JiraFilterPermission [-Filter] <JiraPS.Filter> [-Type] {Group | Project | ProjectRole | Authenticated |
Global} [[-Value] <String>] [[-Credential] <PSCredential>] [-WhatIf] [-Confirm] [<CommonParameters>]
Add-JiraFilterPermission [-Id] <UInt32[]> [-Type] {Group | Project | ProjectRole | Authenticated | Global}
[[-Value] <String>] [[-Credential] <PSCredential>] [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
Share a Filter with other users, such as "Group", "Project", "ProjectRole", "Authenticated" or "Global".
PARAMETERS
-Filter <JiraPS.Filter>
Filter object to which the permission should be applied
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-Id <UInt32[]>
Id of the Filter to which the permission should be applied Id can be passed over the pipeline when reading
from a file.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-Type <String>
Type of the permission to add
Required? true
Position? 1
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Value <String>
Value for the Type of the permission.
The Value differs per Type of the permission.
Here is a table to know what Value to provide: |Type |Value |Source
|
|-------------|---------------------|----------------------------------------------------| |Group |Name
of the Group |Can be retrieved with `(Get-JiraGroup ...).Name` | |Project |Id of the Project
|Can be retrieved with `(Get-JiraProject ...).Id` | |ProjectRole |Id of the ProjectRole|Can be retrieved
with `(Get-JiraProjectRole ...).Id`| |Authenticated| must be null |
| |Global | must be null | |
Required? false
Position? 2
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Credential <PSCredential>
Credentials to use to connect to JIRA.
If not specified, this function will use anonymous access.
Required? false
Position? 3
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
[JiraPS.Filter]
OUTPUTS
[JiraPS.Filter]
NOTES
This functions does not validate the input for `-Value`. In case the value is invalid, unexpected or missing,
the API will response with an error.
This function requires either the `-Credential` parameter to be passed or a persistent JIRA session. See
`New-JiraSession` for more details. If neither are supplied, this function will run with anonymous access to
JIRA.
-------------------------- Example 1 --------------------------
Add-JiraFilterPermission -Filter (Get-JiraFilter 12345) -Type "Global"
#-------
Add-JiraFilterPermission -Id 12345 -Type "Global"
Two methods of sharing Filter 12345 with everyone.
-------------------------- Example 2 --------------------------
12345 | Add-JiraFilterPermission -Type "Authenticated"
Share Filter 12345 with authenticated users. The Id could be read from a file.
-------------------------- Example 3 --------------------------
Get-JiraFilter 12345 | Add-JiraFilterPermission -Type "Group" -Value "administrators"
Share Filter 12345 only with users in the administrators groups.
RELATED LINKS
Online Version: https://atlassianps.org/docs/JiraPS/com ... ermission/
Get-JiraFilter
Get-JiraFilterPermission
Remove-JiraFilterPermission