Guide

API client

Set-IAMAPIClient

Suggest Edits

Synopsis

Update an API client.

Syntax

Set-IAMAPIClient [[-ClientID] <String>] [-Body] <Object> [[-EdgeRCFile] <String>] [[-Section] <String>] [[-AccountSwitchKey] <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

Updates an existing API client. You can provide the API client settings with the -Body parameter or use the pipeline. If you want to edit an API client other than that specified with the -EdgeRCFile and -Section, then you need to provide the -ClientID. Otherwise, the -ClientID has the value of self.

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.
‑Body
Required
Object Pipeline input: ByValue

A request body, either as a PSCustomObject or a string. This parameter supports pipelining.
‑ClientID
String Pipeline input: False

Your API client's ID. To get this value, run Get-IAMAPIClient.
‑EdgeRCFile
String Pipeline input: False

Your EdgeGrid resource file to authenticate your command. Defaults to ~/.edgerc.
‑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