Get-ConfluenceAccessibleResource

SYNOPSIS

List the Atlassian sites (resources) a token can reach.

SYNTAX

__AllParameterSets

Get-ConfluenceAccessibleResource [-Token] <securestring>

ALIASES

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

DESCRIPTION

Calls https://api.atlassian.com/oauth/token/accessible-resources with the token as a bearer credential and returns one object per accessible site. Each result exposes the site id (which is the cloud ID used in the API-gateway base URI), the site url, the name, and the scopes granted to the token for that site. Use it to discover the cloud ID and confirm the granted scopes before connecting.

EXAMPLES

EXAMPLE 1

$token = Read-Host -AsSecureString
Get-ConfluenceAccessibleResource -Token $token

Lists every site the token can reach, with the cloud ID (id), URL and granted scopes.

EXAMPLE 2

(Get-ConfluenceAccessibleResource -Token $token | Where-Object url -match 'msxorg').id

Returns the cloud ID for the msxorg site from the token's accessible resources.

PARAMETERS

-Token

The scoped Atlassian API token as a SecureString.

Type: System.Security.SecureString
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: 0
  IsRequired: true
  ValueFromPipeline: true
  ValueFromPipelineByPropertyName: true
  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

System.Security.SecureString

{{ Fill in the Description }}

OUTPUTS

System.Management.Automation.PSObject

{{ Fill in the Description }}

System.Object

{{ Fill in the Description }}

NOTES

RELATED LINKS