Guide

User entitlements

Get-APIUserEntitlements

Suggest Edits

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. Possible values:

  • API_READ for read-only access
  • API_WRITE for edit access
  • API_VERSIONING for access to version management
  • API_FEATURES for access to Kona Site Defender (KSD) features
  • AAG_FEATURES for access to delivery settings
  • API_PURPOSE for access to resource purpose settings

Parameters

‑AccountSwitchKey
String Pipeline input: False

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.
‑ContractID
Required
String Pipeline input: False

Filters endpoints to a specific contract. You need to specify this along with a -GroupID.
‑EdgeRCFile
String Pipeline input: False

Your EdgeGrid resource file to authenticate your command. Defaults to ~/.edgerc.
‑GroupID
Required
Int Pipeline input: False

Filters endpoints to a specific group. You need to specify this along with a -ContractID.
‑Section
String Pipeline input: False

The section name in your EdgeGrid resource file to retrieve authentication credentials from. Defaults to default.

Related Links

Updated 8 days ago