User entitlements
Get-APIUserEntitlements
Synopsis
Get user entitlements.
Syntax
Get-APIUserEntitlements [-GroupID] <Int32> [-ContractID] <String> [[-EdgeRCFile] <String>]
[[-Section] <String>] [[-AccountSwitchKey] <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
Description
Gets user entitlements based on your assigned permissions. Use this operation to determine whether your user identity assigned to the API client can run various operations to modify data. The operation's response returns an array with these values:
API_READ
for read-only accessAPI_WRITE
for edit accessAPI_VERSIONING
for access to version managementAPI_FEATURES
for access to Kona Site Defender (KSD) featuresAAG_FEATURES
for access to delivery settingsAPI_PURPOSE
for access to resource purpose settings
Parameters
-AccountSwitchKey
Account switch key, for use when you have access to multiple accounts and need to specify which one to use. Run Get-AccountSwitchKey
to list the account switch keys available to you.
Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ContractID
Filters endpoints to a specific contract. You need to specify this along with a -GroupID
.
Type: String
Parameter Sets: (All)
Aliases: None
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-EdgeRCFile
EdgeRC file to authenticate your command. Defaults to ~/.edgerc
.
Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-GroupID
Filters endpoints to a specific group. You need to specify this along with a -ContractID
.
Type: Int32
Parameter Sets: (All)
Aliases: None
Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Section
EdgeRC section to retrieve authentication credentials from. Defaults to default
.
Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
CommonParameters
This cmdlet supports the common parameters: -Debug
, -ErrorAction
, -ErrorVariable
, -InformationAction
, -InformationVariable
, -OutVariable
, -OutBuffer
, -PipelineVariable
, -Verbose
, -WarningAction
, and -WarningVariable
. For more information, see about_CommonParameters.
Inputs
None
Outputs
System.Object
Related links
Updated 7 days ago