Endpoint multistep group

Synopsis

Update a multistep group.

Syntax

Rename-APIEndpointMultistepGroup -APIEndpointName <String> -VersionNumber <String> -MultistepGroupID <String> -NewName <String> [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
Rename-APIEndpointMultistepGroup -APIEndpointID <Int32> -VersionNumber <String> -MultistepGroupID <String> -NewName <String> [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

Change the multistep group's name. To assign an operation to a multistep group, modify its 'multistepGroupId' value. You can only add any given operation to a single group.

Parameters

‑APIEndpointID
Conditionally required

The endpoint's ID.

‑APIEndpointName
Conditionally required

The endpoint's name.

‑AccountSwitchKey

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

Your EdgeGrid resource file to authenticate your command. Defaults to ~/.edgerc.

‑MultistepGroupID
Required

Identifies a multistep group. You must set this value to add an operation to a multistep group. Allowed only for the following operation types: LOGIN, ACCOUNT_VERIFICATION, ACCOUNT_CREATION, PASSWORD_RESET and PAYMENT.

‑NewName
Required

New name for the multistep group.

‑Section

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

‑VersionNumber
Required

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

Related Links