Get Started

API Reference

Cmdlet

New-OfficeConfluenceSession

Namespace PSWriteOffice
Outputs
OfficeIMO.Confluence.ConfluenceSession
Source
Sources/PSWriteOffice/Cmdlets/Confluence/NewOfficeConfluenceSessionCommand.cs:18 Edit on GitHub

Creates an in-memory Confluence Cloud session.

Remarks

Creates an in-memory Confluence Cloud session.

Examples

Authored help example

Example 1: Create a session using an Atlassian email and API token.

PS>


$session = New-OfficeConfluenceSession -SiteUri 'https://example.atlassian.net/' -Credential (Get-Credential)

Use the Atlassian email as the user name and the API token as the password.

Common Parameters

This command supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.

For more information, see about_CommonParameters.

Syntax

New-OfficeConfluenceSession [-ApplicationName <String>] -Credential <PSCredential> [-MaxRetryCount <Int32>] [-RequestTimeoutSeconds <Int32>] -SiteUri <Uri> [<CommonParameters>]
#
Parameter set: Basic

Parameters

ApplicationName String optionalposition: namedpipeline: False
Application name sent with requests.
Credential PSCredential requiredposition: namedpipeline: False
Atlassian email and API token credential.
MaxRetryCount Int32 optionalposition: namedpipeline: False
Maximum retry count for safe read requests. Writes are never retried automatically.
RequestTimeoutSeconds Int32 optionalposition: namedpipeline: False
Per-request timeout in seconds.
SiteUri Uri requiredposition: 0pipeline: False
HTTPS root URI of the Confluence Cloud site.

Outputs

OfficeIMO.Confluence.ConfluenceSession

New-OfficeConfluenceSession -AccessToken <SecureString> [-ApplicationName <String>] -CloudId <String> [-MaxRetryCount <Int32>] [-RequestTimeoutSeconds <Int32>] -SiteUri <Uri> [<CommonParameters>]
#
Parameter set: Bearer

Parameters

AccessToken SecureString requiredposition: namedpipeline: False
OAuth access token stored as a secure string.
ApplicationName String optionalposition: namedpipeline: False
Application name sent with requests.
CloudId String requiredposition: namedpipeline: False
Atlassian Cloud identifier required for OAuth bearer-token routing.
MaxRetryCount Int32 optionalposition: namedpipeline: False
Maximum retry count for safe read requests. Writes are never retried automatically.
RequestTimeoutSeconds Int32 optionalposition: namedpipeline: False
Per-request timeout in seconds.
SiteUri Uri requiredposition: 0pipeline: False
HTTPS root URI of the Confluence Cloud site.

Outputs

OfficeIMO.Confluence.ConfluenceSession