Endpoint multistep group

Synopsis

Get a multistep group.

Syntax

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

Description

Get the multistep group's name. To find out which operations are a part of this multistep group, Get-APIEndpointVersionResourcesAndOperations resource operations and check their 'multistepGroupId'.

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

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
  • PAYMENT
  • ‑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