Skip to content

Get-ConfluenceRestriction

SYNOPSIS

Get the content restrictions on a page (read:content-details).

SYNTAX

__AllParameterSets

Get-ConfluenceRestriction [-PageId] <string> [[-Context] <Object>]

ALIASES

This cmdlet has the following aliases, {{Insert list of aliases}}

DESCRIPTION

Returns the read/update restrictions applied to a page. Reading restrictions requires read:content-details; the read:content.restriction scope only covers the narrow byOperation/{op}/user|group status checks. Content restrictions are part of the v1 content API (see the link).

EXAMPLES

EXAMPLE 1

Get-ConfluenceRestriction -PageId '12345'

Gets the read/update restrictions on page 12345.

PARAMETERS

-Context

The context to use: an object, a context name, or $null for the default.

Type: System.Object
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: 1
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-PageId

The page ID.

Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: 0
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

NOTES