EdgeGrid auth token

New-EdgeAuthToken

Synopsis

Create an Edge auth token.

Syntax

New-EdgeAuthToken -Secret <String> [-StartTime <Int32>] [-EndTime <Int32>] [-DurationInSeconds <Int32>] [-DurationInMinutes <Int32>] [-DurationInHours <Int32>] [-URL <String>] [-EscapeInputs] [-IP <String>] [-Data <String>] [-ID <String>] [-Salt <String>] [-Delimiter <String>] [-Algorithm <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

New-EdgeAuthToken -Secret <String> [-StartTime <Int32>] [-EndTime <Int32>] [-DurationInSeconds <Int32>] [-DurationInMinutes <Int32>] [-DurationInHours <Int32>] [-ACL <String>] [-EscapeInputs] [-IP <String>] [-Data <String>] [-ID <String>] [-Salt <String>] [-Delimiter <String>] [-Algorithm <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

Various Akamai services make use of Token Authentication or similar services, which require encrypted tokens. This function will create such a token from the given inputs for you to use in testing or live requests.

Parameters

-ACL

An acl element to include in the edge auth token.

Type: String
Parameter Sets: acl
Aliases:

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

-Algorithm

An algorithm to use in calculating the edge auth token signature. Defaults to sha256 but also accepts sha1 and md5.

Type: String
Parameter Sets: (All)
Aliases:
Accepted values: sha256, sha1, md5

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

-Data

The data element to include in the edge auth token.

Type: String
Parameter Sets: (All)
Aliases:

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

-Delimiter

the field delimiter. Defaults to ~.

Type: String
Parameter Sets: (All)
Aliases:

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

-DurationInHours

The token duration in hours. During token generation, it's converted to seconds.

Type: Int32
Parameter Sets: (All)
Aliases:

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

-DurationInMinutes

The token duration in minutes. During token generation, it's converted to seconds.

Type: Int32
Parameter Sets: (All)
Aliases:

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

-DurationInSeconds

The token duration in seconds.

Type: Int32
Parameter Sets: (All)
Aliases:

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

-EndTime

The token end time in epoch format.

Type: Int32
Parameter Sets: (All)
Aliases:

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

-EscapeInputs

When the switch parameter is present, it forces a URL token element to be URL-encoded.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-ID

The id element to include in the edge auth token.

Type: String
Parameter Sets: (All)
Aliases:

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

-IP

The ip element to include in the edge auth token.

Type: String
Parameter Sets: (All)
Aliases:

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

-Salt

The salt element to include in the edge auth token.

Type: String
Parameter Sets: (All)
Aliases:

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

-Secret

The secret key for encryption.

Type: String
Parameter Sets: (All)
Aliases:

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

-StartTime

The token start time in epoch format.

Type: Int32
Parameter Sets: (All)
Aliases:

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

-URL

The url element to include in the edge auth token.

Type: String
Parameter Sets: url
Aliases:

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