Cmdlet
New-OfficeConfluenceSession
Creates an in-memory Confluence Cloud session.
Syntax
New-OfficeConfluenceSession
[-ApplicationName <String>]
-Credential <PSCredential>
[-MaxRetryCount <Int32>]
[-RequestTimeoutSeconds <Int32>]
[-SiteUri] <Uri>
[<CommonParameters>]#Parameter set:
BasicNew-OfficeConfluenceSession
-AccessToken <SecureString>
[-ApplicationName <String>]
-CloudId <String>
[-MaxRetryCount <Int32>]
[-RequestTimeoutSeconds <Int32>]
[-SiteUri] <Uri>
[<CommonParameters>]#Parameter set:
BearerExamples
Create a session using an Atlassian email and API token.
$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.
Parameters
- -ApplicationName String
- Application name sent with requests.
- -Credential PSCredential
- Atlassian email and API token credential.
- -MaxRetryCount Int32
- Maximum retry count for safe read requests. Writes are never retried automatically.
- -RequestTimeoutSeconds Int32
- Per-request timeout in seconds.
- -SiteUri Uri
- HTTPS root URI of the Confluence Cloud site.
- -AccessToken SecureString
- OAuth access token stored as a secure string.
- -CloudId String
- Atlassian Cloud identifier required for OAuth bearer-token routing.
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.