Guide

Endpoint version PII

New-APIEndpointVersionPII

Suggest Edits

Synopsis

Add or update a user-created PII instance.

Syntax

New-APIEndpointVersionPII -APIEndpointName <String> -VersionNumber <String> -ParamID <Int32> -Types <String> [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

New-APIEndpointVersionPII -APIEndpointID <Int32> -VersionNumber <String> -ParamID <Int32> -Types <String> [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

Adds or updates the PII (personally identifiable information) in an API parameter. Use this operation to add the PII to or modify it in your API definition, rather than the network discovering the PII for you.

In the request body, you can specify an API endpoint by its name or ID. The -VersionNumber parameter is an integer or the word latest.

Parameters

‑APIEndpointID
Conditionally required
Int Parameter sets: id Pipeline input: False

The endpoint's ID.
‑APIEndpointName
Conditionally required
String Parameter sets: name Pipeline input: False

The endpoint's name.
‑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.
‑EdgeRCFile
String Pipeline input: False

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

The parameter's ID.
‑Section
String Pipeline input: False

The section name in your EdgeGrid resource file to retrieve authentication credentials from. Defaults to default.
‑Types
Required
String Pipeline input: False

The set of PII types you want to add to the parameter. The API supports PERSONAL or CREDITOR.
‑VersionNumber
Required
String Pipeline input: False

The endpoint version's number. Can be an integer or 'latest'.

Related Links

Updated 1 day ago