Akamai session

New-AkamaiSession

Synopsis

Creates a new Akamai Session info variable in the Script scope

Syntax

New-AkamaiSession -ClientSecret <String> -HostName <String> -ClientAccessToken <String> -ClientToken <String> [-AccountSwitchKey <String>] [-Environment <String>] [-Passthrough] [-ProgressAction <ActionPreference>] [<CommonParameters>]
New-AkamaiSession -EdgeRCJSON <String> [-Passthrough] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

The New-AkamaiSession cmdlet creates a new Akamai Session variable.

Used by the Invoke-AkamaiRestMethod cmdlet's authentication scheme.

Examples


New-AkamaiSession -ClientSecret "C113nt53KR3TN6N90yVuAgICxIRwsObLi0E67/N8eRN=" -HostName "akab-h05tnam3wl42son7nktnlnnx-kbob3i3v.luna.akamaiapis.net" -AccessToken "akab-acc35t0k3nodujqunph3w7hzp7-gtm6ij" -ClientToken "akab-c113ntt0k3n4qtari252bfxxbsl-yvsdj"

New-AkamaiSession -EdgeRCJSON "~./path/to/edgerc.json"

Parameters

‑ClientSecret
Conditionally required

The API credential's client secret.

‑HostName
Conditionally required

The API credential's hostname.

‑ClientAccessToken
Conditionally required

The API credential's client access token.

‑ClientToken
Conditionally required

The API credential's client token.

‑AccountSwitchKey

An account credential key that lets you move between accounts when using an API client enabled for multiple accounts. To find account switch keys, use Get-AccountSwitchKey.

‑Environment

The session environment. Similar to the use of the -Section parameter in an .edgerc file.

‑EdgeRCJSON
Conditionally required

The JSON string representing the session data.

‑Passthrough

When the switch parameter is present, the function returns session data.

Related Links

User Guide: Overview