Guide

API credential

Remove-IAMAPICredential

Suggest Edits

Synopsis

Remove a credential.

Syntax

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

Description

Deletes a specific credential from an API client. You can only delete inactive credentials.

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.
‑CredentialID
Required
String Pipeline input: False

Your credentials' ID. To get this value for your credentials, run Get-IAMAPICredential.
‑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 about 1 month ago