Guide

API client

Remove-IAMAPIClient

Suggest Edits

Synopsis

Delete an API client.

Syntax

Remove-IAMAPIClient [[-ClientID] <String>] [[-EdgeRCFile] <String>] [[-Section] <String>] [[-AccountSwitchKey] <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

Permanently deletes the API client, breaking any API connections with the client. To delete a client, you need to own the client or have admin access to a given group. Before deleting an API client, make sure there aren't any API integrations or scripts using it.

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.
‑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 6 days ago