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

POST with inline credentials.

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

POST with path to your credentials file.

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

Parameters

-ClientSecret

An API client's client secret.

Type: String
Parameter Sets: Individual
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-HostName

The API credential's hostname.

Type: String
Parameter Sets: Individual
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ClientAccessToken

The API credential's client access token.

Type: String
Parameter Sets: Individual
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ClientToken

An API client's client token.

Type: String
Parameter Sets: Individual
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-AccountSwitchKey

Account switch key, for use when an API client has access to multiple accounts.

Type: String
Parameter Sets: Individual
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Environment

Alias = Section.
The environment for which the authorization information is used.
Default is default.

Type: String
Parameter Sets: Individual
Aliases: Section

Required: False
Position: Named
Default value: Default
Accept pipeline input: False
Accept wildcard characters: False

-EdgeRCJSON

The path to a JSON file that contains API credentials.
Multiple credential sections allowed.
If used, individual authorization parameters are ignored.

Type: String
Parameter Sets: json
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Passthrough

Returns the session variable instead of setting the script scope session variable.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False