Connect-Confluence

SYNOPSIS

Connect to Confluence and store a credential profile in the context vault.

SYNTAX

Site (Default)

Connect-Confluence -Site <string> -Username <string> -Token <securestring> [-Name <string>]
 [-SpaceKey <string>] [-PassThru] [-WhatIf] [-Confirm]

CloudId

Connect-Confluence -CloudId <string> -Username <string> -Token <securestring> [-Name <string>]
 [-SpaceKey <string>] [-PassThru] [-WhatIf] [-Confirm]

ALIASES

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

DESCRIPTION

Validates the supplied credentials with a lightweight authenticated call, stores them as a named context (the token is kept as a SecureString), and records the context as the module default. Supply the site with -Site (a name such as 'msxorg', a host, or a URL) and the cloud ID is resolved automatically; or pass a known -CloudId directly to skip the lookup. A token that authenticates but lacks the read:space scope still connects (with a warning).

EXAMPLES

EXAMPLE 1

$token = Read-Host -AsSecureString
Connect-Confluence -Site 'msxorg' -Username $user -Token $token -SpaceKey 'DOCS'

Resolves the cloud ID for msxorg.atlassian.net, connects, and stores 'DOCS' as the default space.

EXAMPLE 2

Connect-Confluence -CloudId 'fff64f40-36b7-4578-92be-b9d9b6b17658' -Username $user -Token $token

Connects directly with a known cloud ID, skipping the site lookup.

PARAMETERS

-CloudId

The Confluence Cloud ID - a faster alternative to -Site that skips the lookup. Find it with Get-ConfluenceCloudId or Get-ConfluenceAccessibleResource.

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

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: System.Management.Automation.SwitchParameter
DefaultValue: ''
SupportsWildcards: false
Aliases:
- cf
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-Name

The context name to store the profile under. Defaults to '//'.

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

-PassThru

Return the stored context.

Type: System.Management.Automation.SwitchParameter
DefaultValue: False
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-Site

The Confluence Cloud site: a name (msxorg), a host (msxorg.atlassian.net), or any URL on the site. The cloud ID is resolved automatically.

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

-SpaceKey

An optional default space key stored with the profile.

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

-Token

The scoped Atlassian API token as a SecureString.

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

-Username

The service-account user (email) used for HTTP Basic authentication.

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

-WhatIf

Runs the command in a mode that only reports what would happen without performing the actions.

Type: System.Management.Automation.SwitchParameter
DefaultValue: ''
SupportsWildcards: false
Aliases:
- wi
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  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

System.Management.Automation.PSObject

{{ Fill in the Description }}

NOTES

RELATED LINKS